Custom Class Annotations about openapi.net.csharpannotations HOT 5 CLOSED

@jdusome Do you want these annotations <x-ms-notification-url> to show up as https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.2.md#specificationExtensions ? If so you can achieve that my writing a custom filter class that derives from https://github.com/microsoft/OpenAPI.NET.CSharpAnnotations/blob/master/src/Microsoft.OpenApi.CSharpAnnotations.DocumentGeneration/OperationFilters/IOperationFilter.cs and update filter to parse these tags and update the document.

And passing it to the library for an example take a look at test case GetTestCasesForPassANewFilterAndShouldReturnCorrectDocument in https://github.com/microsoft/OpenAPI.NET.CSharpAnnotations/blob/master/test/Microsoft.OpenApi.CSharpAnnotations.DocumentGeneration.Tests/OpenApiDocumentGeneratorTests/OpenApiDocumentGeneratorTest.cs

let me know if you have any specific question around custom filter,

from openapi.net.csharpannotations.

I think that is precisely what I am looking for, I will give that a shot and get back to you if I have any questions regarding the custom filter. Thank you.

from openapi.net.csharpannotations.

@Shwetap05 I was able to successfully use an Operation Filter to get some of the custom Microsoft extensions into the Open API document. Thank you very much for your response. Is it possible to do something similar for the Schemas that are generated? In my original post, I am referring to the object that is returned from an operation. The library is currently able to import the summary, although it would be really nice if I could also import additional elements as well.

from openapi.net.csharpannotations.

@jdusome can you please provide more details on what additional elements you want included in schema?

from openapi.net.csharpannotations.

@Shwetap05 Certainly! In the original screenshot, you can see that I created the XML style comments on my PortalUserRegistrationSubscribeRequest object. It generates the second screenshot in the Open API definition, though I would like to generate the following:

(Notice the custom x-ms attributes on the callBackUrl property)

I was able to accomplish this for the operations using an Operation Filter as you suggested, but I would like to accomplish something similar for the Schemas that being generated.

from openapi.net.csharpannotations.