...
As mentioned above, optional query parameters that are parsed dynamically are not recognized by the AI tool while generating XML Document Documentation comments. As a workaround, we introduced two new attributes that can be used to decorate API endpoint method in order to display a given query parameter(s) in Swagger UI.
- 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.
- To add general purpose query parameter(s) that can be reused throughout multiple controllers, use [QueryParameters] attribute, typically paging query parameters, etc ... (see example below).
- Parameter type and description is predefined in this class : https://git.allplan.com/projects/SRVC/repos/api/browse/src/BimPlus.Server.Web/Core/QueryParametersAttribute.cs
Adding optional request body
...