mirror of
https://github.com/Redocly/redoc.git
synced 2024-11-24 17:43:45 +03:00
c407726a66
* docs: adds vale rules and workflow for running in CI * docs: updates product name from ReDoc to Redoc
24 lines
644 B
Markdown
24 lines
644 B
Markdown
# Injection security definitions
|
|
|
|
You can inject the Security Definitions widget anywhere in your specification `description`:
|
|
|
|
```markdown
|
|
...
|
|
# Authorization
|
|
|
|
Some description
|
|
|
|
<!-- Redoc-Inject: <security-definitions> -->
|
|
...
|
|
```
|
|
The inject instruction is wrapped in an HTML comment,
|
|
so it is **visible only in Redoc** and not visible, for instance, in the SwaggerUI.
|
|
|
|
# Default behavior
|
|
|
|
If the injection tag is not found in the description, it is appended to the end
|
|
of description under the `Authentication` header.
|
|
|
|
If the `Authentication` header is already present in the description,
|
|
Security Definitions are not inserted or rendered.
|