solo-io / gloo-portal-issues

Public tracker for issues related to Gloo Portal
https://docs.solo.io/gloo-portal/latest/
1 stars 3 forks source link

provide a link to download the stitched OpenApi spec of an ApiProduct #87

Closed bcollard closed 2 years ago

bcollard commented 2 years ago

Is your feature request related to a problem? Please describe. Developers would like to consume the ApiProduct OpenApi spec. That sounds totally reasonable!

Describe the solution you'd like A link in the developer portal web UI, when we have selected an API(product) For example, if my Portal CR uses the domain portal.mycompany.corp and if I have an ApiProduct named petstore-product in the default namespace, then... I'm expecting the OpenAPI spec to be available on this page: http://portal.mycompany.corp/apis/default/petstore-product?v=v1 via a link or a pre-defined URL.

Describe alternatives you've considered Parsing the APIProduct CR. Not developer-friendly.

Additional context Gloo Portal 1.0.1

chrisgaun commented 2 years ago

Can download a product with the combined APIs.

marcogschmidt commented 2 years ago

@bcollard Would a button in the portal web UI through which users can download the spec be enough to enable this use case?

chrisgaun commented 2 years ago

@bcollard a few things to make this easier.

We should probably limit the download to per version.

We should probably limit this to REST APIs.

joaomvalentim commented 2 years ago

Please consider both options, i.e, a link in the portal AND an url where the spec is available without the need to login into the portal, Thanks.

arianaw66 commented 2 years ago

A new download button was added to the Portal UI and should be released in v1.2.0-beta3. We'll create another issue for the download URL.

chrisgaun commented 2 years ago

This was phase 1 btw, Test it out and let us know. We can pick up the "download URL" after confirm this is behavior you want.