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

Feature: Show API output without entering credentials #56

Open
brycefisher opened this issue Jan 26, 2016 · 4 comments
Open

Feature: Show API output without entering credentials #56

brycefisher opened this issue Jan 26, 2016 · 4 comments

Comments

@brycefisher
Copy link

Currently, one must enter their credentials into quay API Explorer to see the output of an endpoint. I'm not 100% comfortable entering my credentials there...

I'm only a little familiar with swagger, but it would be really nice to see some json or some indication of what the endpoints will output.

@jzelinskie
Copy link
Contributor

Are you using Quay.io or Quay Enterprise? Are you running your own docs container?

I'm not 100% comfortable entering my credentials there...

The swagger page uses OAuth and client-side ajax requests to do everything. It's safe to enter your credentials as they'll only ever be on your machine.

@brycefisher
Copy link
Author

Quay.io, not using the docs container. Yeah, I hear you.

It would be nice to be able to read what the output would be without having to trigger all of those conditionals, even just from a usability perspective and forgetting about security issues.

Does swagger not support that?

@josephschorr
Copy link
Contributor

Swagger does support it but it requires having every API endpoint explicitly define the union of its various outputs, which is quite tedious to maintain. We'll give some more thought as to how we can go about doing so.

@brycefisher
Copy link
Author

Yikes! That sounds like it could go horribly out of date quickly.

Hmm, is it possible to extract sample (dumby) response from your source code automatically?

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

3 participants