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

Add allowReserved to Security Scheme Object #1676

Closed
Raptor399 opened this issue Aug 26, 2018 · 1 comment
Closed

Add allowReserved to Security Scheme Object #1676

Raptor399 opened this issue Aug 26, 2018 · 1 comment
Labels

Comments

@Raptor399
Copy link

I ran into swagger-api/swagger-ui#4218 and it occurred to me that perhaps the allowReserved option of Parameter Objects could also be added as an optional parameter to Security Scheme Objects, allowing for a definition like:

components:
  securitySchemes:
    KeyA:
      type: apiKey
      in: cookie
      name: key-a
      allowReserved: true

If allowReserved serves valid use cases for query parameters in Parameter Objects, it would be consistent to also allow this this flag for similar use cases in Security Scheme Objects.

@darrelmiller
Copy link
Member

Currently we don't limit the characters allowed in security parameters and don't think AllowReserved would add significant value. If this is essential for your scenario we recommend using an extension to describe allowed characters.

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

No branches or pull requests

3 participants