Skip to content
This repository has been archived by the owner on Sep 21, 2023. It is now read-only.

Feature Request: Display OAuth scope required for each API operation in the html #55

Open
brycefisher opened this issue Jan 15, 2016 · 2 comments

Comments

@brycefisher
Copy link

The API discovery endpoint already contains information about which implicit scope is required for each endpoint:

screen shot 2016-01-15 at 9 46 37 am

However, in the corresponding html shown on the generated API docs doesn't show the required scope anywhere that I can see.

screen shot 2016-01-15 at 9 49 57 am

It would be nice to list out the scopes somewhere in the html to more easily determine which scopes are necessary to grant to an OAuth application for a specific use case. Thanks Quay!

@josephschorr
Copy link
Contributor

@brycefisher: That display comes from the Swagger UI, which is an open source tool found here: https://github.com/swagger-api/swagger-ui. If you update the tool to show the scopes in that display, then we can merge the changes. Otherwise, you can click on the Auth toggle (which says "off" in your screenshot), and it should show which scope is necessary.

@brycefisher
Copy link
Author

Thanks for the speedy reply @josephschorr ! I wondered about that :-/

Clicking on the off pops up this modal, which displays the scopes required by the Swagger UI to run all of the examples; it does not indicate the minimum scopes required for that API endpoint. See screenshot:

screen shot 2016-01-15 at 2 04 46 pm

I assume this piece is also generated from Swagger. Is that correct?

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants