search

Azure / azure-functions-openapi-extension

This extension provides an Azure Functions app with Open API capability for better discoverability to consuming parties
https://www.nuget.org/packages/Microsoft.Azure.WebJobs.Extensions.OpenApi/
MIT License
372 stars 195 forks source link

Roadmap for v2 and v3 #357

Open justinyoo opened 2 years ago

justinyoo commented 2 years ago

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

V3

cloud-devlpr commented 2 years ago

Is it possible to generate OpenAPI doc by tags, similar to the web interface, using CLI azfuncopenapi

justinyoo commented 2 years ago

Is it possible to generate OpenAPI doc by tags, similar to the web interface, using CLI azfuncopenapi

Yes, it's possible. Find this doc.

usamaa9 commented 2 years ago

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

DiaAWAY commented 2 years ago

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.

justinyoo commented 2 years ago

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.

johnnyreilly commented 2 years ago

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!

sajagjain commented 1 year ago

@justinyoo It has been a year now. Do you have it in the roadmap now?

Craigology commented 1 year ago

@justinyoo Hope you're well 👋 What's the current position regarding official support for .NET 8? Thanks.

justinyoo commented 1 year ago

@Craigology We're supporting .NET 8 as well. The current version 1.5.1 works on .NET 8 RC1, though.

KarenTazayan commented 11 months ago

Hi @justinyoo, is this project retired? I haven't seen any new releases since January.

verdantburrito commented 11 months ago

Can we please get an updated roadmap, & also ideally when we might expect to see 2.0 and/or 3.0 released?

Skovvart commented 11 months ago

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.

Mivaweb commented 3 months ago

Any news on this? Also the request for using the FullNamespace is required for some of us. Not even available in the 2.0.0- preview releases...