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.

Sign up for GitHub

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

Jump to bottom

Clairfy api key auth's scheme #1714

Merged
merged 1 commit into from
Apr 4, 2023
Merged

Clairfy api key auth's scheme #1714

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 7 additions & 2 deletions docs/source-2.0/spec/authentication-traits.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -182,8 +182,10 @@ properties:
This value can be set to ``header`` or ``query``.
* - scheme
- ``string``
- Defines the security scheme to use on the ``Authorization`` header value
This can only be set if the "in" property is set to ``header``.
- Defines the scheme to use on the ``Authorization`` header value. As
defined in :rfc:`9110#section-11.4`. This scheme SHOULD be one of the
schemes defined in the `IANA Authentication Scheme Registry`_. This can
only be set if the "in" property is set to ``header``.

The following example defines a service that accepts an API key in the "X-Api-Key"
HTTP header:
Expand Down Expand Up @@ -367,3 +369,6 @@ authentication scheme trait that is not applied to the service:

@auth([httpBasicAuth]) // <-- Invalid!
operation OperationA {}


.. _IANA Authentication Scheme Registry: https://www.iana.org/assignments/http-authschemes