redoc/docs/security-definitions-injection.md
Heather Cloward c407726a66
docs: adds vale rules and workflow for running in CI (#2348)
* docs: adds vale rules and workflow for running in CI

* docs: updates product name from ReDoc to Redoc
2023-07-11 13:31:52 -04:00

644 B

Injection security definitions

You can inject the Security Definitions widget anywhere in your specification description:

...
# 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.