azure-functions-openapi-extension
azure-functions-openapi-extension copied to clipboard
Azure
Roadmap for v2 and v3
This is the list of features, enhancements, and bug fixes to be released into the upcoming releases, especially with breaking changes.
This is not the complete list, which can be changing at any time.
From the release of May, 2022, this extension will no longer target .NET 5. For more details, please visit this page.
V2
- Power Platform Custom Connector supports:
- #36
- #231
- OpenApiSettings.IncludeRequestingHostName ➡️ ExcludeRequestingHost
- #390
- #393
- #397
V3
- System.Text.Json support:
- #154
Is it possible to generate OpenAPI doc by tags, similar to the web interface, using CLI azfuncopenapi
Is it possible to generate OpenAPI doc by tags, similar to the web interface, using CLI azfuncopenapi
Yes, it's possible. Find this doc.
Can we include support for generating open api doc from xml documentation #348 ? This would be really useful and personally I think it is better than using Attributes to describe models etc
Can we include support for generating open api doc from xml documentation #348 ? This would be really useful and personally I think it is better than using Attributes to describe models etc
I agree, we're already very used to using XML comments to decorate our swagger/openapi documents from source code, and we do this extensively in our current functions and asp.net solutions, and it makes it easier when sharing logic and (particularly) models across solutions (primarily asp.net and azure functions + durable functions) which we then generate swagger files for APIM.
Older swagger generation support enabled us to include XML documentation if we desired to do so, in addition XML documentation is also what is described for ASP.NET openapi/swagger, of course azure functions isn't asp.net - but it would be nice if the Microsoft eco system agreed on how to annotate models for openapi/swagger generation instead of creating new annotations in different packages for different frameworks.
We don't currently have a concrete roadmap to support XML comments for now like what Swashbuckle offers. But we'll keep that discussion open.
It would be great to have a way to validate that the schema generated and the underlying function don't go out of sync. There's a discussion partway down this issue on the topic:
https://github.com/Azure/azure-functions-openapi-extension/issues/350#issuecomment-1034528702
Might actually be good to open this as a distinct issue, as each time I look for the discussion I struggle to find it!
@justinyoo Hope you're well 👋 What's the current position regarding official support for .NET 8? Thanks.
@Craigology We're supporting .NET 8 as well. The current version 1.5.1 works on .NET 8 RC1, though.
Hi @justinyoo, is this project retired? I haven't seen any new releases since January.
Can we please get an updated roadmap, & also ideally when we might expect to see 2.0 and/or 3.0 released?
Unless V2 is near ready (or trivial to complete), #154 is significantly more important for my (and I would assume the majority of) use cases, and would like to request a reprioritization of the roadmap.
