Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

v3.0.3: Security Scheme, OAuthFlows examples do not validate against the spec #2168

Closed
stuartherbert opened this issue Mar 2, 2020 · 3 comments

Comments

@stuartherbert
Copy link

The Security Scheme Object lists the following fields as REQUIRED:

  • type
  • name
  • in
  • scheme
  • flows
  • openIdConnectUrl

The majority of examples (in the same doc) that include SecurityScheme objects, however, are missing many of these fields.

I'm guessing this is a spec error, that whether or not these fields are required is based on the value of the Security Scheme object's type field? If that's correct, does the spec need updating to clarify when these fields are required?

There's a problem with the OAuth Flow Object, where tokenUrl is listed as a REQUIRED field, but is missing from the implicit flow of the inline examples. I'm guessing that this is related - another field that is only required depending on the flow type? If so, does the spec need updating to clarify that too?

@MikeRalphson
Copy link
Member

This is the purpose of the "Applies To" column.

@stuartherbert
Copy link
Author

@MikeRalphson thank you. Now you've pointed it out, it's obvious. It wasn't at all obvious until then, though.

@MikeRalphson
Copy link
Member

Please feel free to suggest additional or alternative wording, though I think this is the first time this has come up.

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

No branches or pull requests

2 participants