✨ Add description parameter to all the security scheme classes, e.g. APIKeyQuery(name="key", description="A very cool API key")#1757
Merged
Conversation
Codecov Report
@@ Coverage Diff @@
## master #1757 +/- ##
==========================================
Coverage 100.00% 100.00%
==========================================
Files 390 401 +11
Lines 9747 10080 +333
==========================================
+ Hits 9747 10080 +333
Continue to review full report at Codecov.
|
blkst8
reviewed
Aug 8, 2020
blkst8
reviewed
Aug 8, 2020
blkst8
reviewed
Aug 8, 2020
Contributor
|
📝 Docs preview for commit 466ddff at: https://5f32a7229003b29d44a1ebab--fastapi.netlify.app |
description parameter to all the security scheme classes, e.g. APIKeyQuery(name="key", description="A very cool API key")
Contributor
|
📝 Docs preview for commit c55a195 at: https://610282e611c6c0ad2ef9978a--fastapi.netlify.app |
Member
|
Thanks @hylkepostma! ☕ And thanks @nimctl for the review. 🤓 I updated it to include the Thanks for your contribution! 🚀 🍰 This will be available later today in FastAPI version |
solomein-sv
pushed a commit
to solomein-sv/fastapi
that referenced
this pull request
Jul 30, 2021
…. `APIKeyQuery(name="key", description="A very cool API key")` (fastapi#1757) Co-authored-by: Hylke Postma <[email protected]> Co-authored-by: Sebastián Ramírez <[email protected]>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
My suggestion is to add a description parameter to the
__init__methods ofAPIKeyQuery(SecurityBase):,APIKeyHeader(SecurityBase):andAPIKeyCookie(SecurityBase):and use it to initialize theAPIKeyobject. This allows for a description in thesecuritySchemesobjects of theopenapi.jsonand therefore in the Swagger and Redoc documentation.class SecurityBase(BaseModel):already has an attributedescription: Optional[str] = None.class APIKey(SecurityBase):inherits from SecurityBase.The classes
APIKeyQuery(SecurityBase):,APIKeyHeader(SecurityBase):andAPIKeyCookie(SecurityBase):initialize anAPIKeyobject in their__init__method. They initialize it with some kwargs and thenameparameter, but currently without a description parameter.Example: using
APIKeyQuery(name="X-Auth-Key", auto_error=False, description="My description")would look likt this in Redoc: