Redocly/redoc
1
1
Fork 0
mirror of https://github.com/Redocly/redoc.git synced 2024-09-21 03:08:48 +03:00
Code Issues Packages Projects Releases Wiki Activity

Security definitions docs

Browse Source
This commit is contained in:
Roman Hotsiy 2016-10-31 12:32:17 +02:00
parent 9e7ba0ea8d
commit 9955cb8fec
No known key found for this signature in database
GPG Key ID: 5CB7B3ACABA57CB0
2 changed files with 22 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
README.md
View File

@ -94,6 +94,9 @@ For npm:
## Configuration
### Security Definition location
You can inject Security Definitions widget into any place of your specification `description`. Check out details [here](docs/security-definitions-injection.md).
### Swagger vendor extensions
ReDoc makes use of the following [vendor extensions](http://swagger.io/specification/#vendorExtensions):
* [`x-logo`](docs/redoc-vendor-extensions.md#x-logo) - is used to specify API logo

19
docs/security-definitions-injection.md Normal file
View File

@ -0,0 +1,19 @@
# Injection security definitions
You can inject Security Definitions widget into any place of your specification `description`:
```markdown
...
# Authorization
Some description
<!-- ReDoc-Inject: <security-definitions> -->
...
```
Inject instruction is wrapped into HTML comment so it is **visible only in ReDoc**. It won't be visible e.g. in SwaggerUI.
# Default behavior
If injection tag is not found in the description it will be appended to the end
of description under `Authentication` header.
If `Authentication` header is already present in the description, Security Definitions won't be inserted and rendered at all.