api-management-developer-portal icon indicating copy to clipboard operation
api-management-developer-portal copied to clipboard

Support for displaying Callbacks documentation

Open sidtheblue opened this issue 6 years ago • 13 comments

The operations page does not display details of "Callbacks" section included in Open API 3.0: https://swagger.io/docs/specification/callbacks/

Please could any callbacks defined against an operation be displayed in the new developer portal, in a similar way to Swagger UI

sidtheblue avatar Sep 30 '19 11:09 sidtheblue

@sidtheblue Could you please let us know if you're able to see callbacks in the OpenAPI file generated by API Management, after you create an API by importing your own OpenAPI file with callbacks defined?

You can access the API Management generated file through Azure portal (https://docs.microsoft.com/en-us/azure/api-management/edit-api#update-the-swagger) or through the developer portal (download dropdown).

mikebudzynski avatar Sep 30 '19 18:09 mikebudzynski

Hi, the answer is no. APIM seemingly "ignores" the callbacks block in Open API 3 specs. When you then choose to export the API Definition in the classic (or new) developer portal, the spec that is returned omits the callbacks section that was originally included in the imported swagger.

sidtheblue avatar Oct 01 '19 11:10 sidtheblue

@sidtheblue - Thanks for checking. We first need to implement support for callback in API Management (I took a note of that) and then include it on the developer portal.

Our goal for GA of the new portal is feature parity with the old one. We'll look again into this request at a later date.

mikebudzynski avatar Oct 01 '19 15:10 mikebudzynski

@sidtheblue We're moving all the feature requests to our Feedback Forum. Could you please open this feature request again at https://aka.ms/apimwish?

mikebudzynski avatar Oct 30 '19 18:10 mikebudzynski

Any updates on this?

apaulro avatar Jan 12 '21 03:01 apaulro

Reopening this issue, since we're now tracking feature requests on GitHub. There are no updates.

mikebudzynski avatar Jan 13 '21 01:01 mikebudzynski

It would be great, if this feature request could be prioritized. It doesn't work well with our partners that we now have to send them separate Open Api documents to document the callbacks in our solutions.

swjensen avatar Apr 27 '22 07:04 swjensen

It would be great, if this feature request could be prioritized. It doesn't work well with our partners that we now have to send them separate Open Api documents to document the callbacks in our solutions.

We are doing the same thing, was hoping this would be included now we have support to import OpenAPI version 3.1

janoosthoek avatar Apr 29 '22 11:04 janoosthoek