Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

  • To add controller or method specific query parameter, use [QueryParameter] attribute (see example below). Parameter type and description should be entered directly when adding the attribute.

Image Modified

Image Modified

Adding optional request body

As mentioned above, optional request body being parsed dynamically is not recognized by the AI tool while generating XML Documentation comments. For that purpose we can use [SwaggerOperationFilter] attribute to decorate the API endpoint method. . in progressThis filter attribute is implemented here : https://git.allplan.com/projects/SRVC/repos/api/browse/src/BimPlus.Server.Web/swagger/OptionalRequestBodyFilter.cs

  • To add optional request body, use the attribute with the appropriate Dto (see the example below)

Image Added

Adding conditional headers

...