mirror of
https://github.com/valitydev/swag-analytics.git
synced 2024-11-06 08:45:28 +00:00
25 lines
741 B
Markdown
25 lines
741 B
Markdown
|
## Global headers
|
||
|
|
|
||
|
|
In order to minimize duplications you can use `headers` global object (similar to `definitions`, `responses`).
|
||
|
|
During build process all references to global `headers` will be inlined and `headers` will be removed form resulting spec so spec will be valid (global `headers` is not allowed by Swagger spec):
|
||
|
|
|
||
|
|
Example:
|
||
|
|
```yaml
|
||
|
|
...
|
||
|
|
headers:
|
||
|
|
Rate-Limit-Limit:
|
||
|
|
description: The number of allowed requests in the current period
|
||
|
|
type: integer
|
||
|
|
...
|
||
|
|
paths:
|
||
|
|
/api-keys:
|
||
|
|
get:
|
||
|
|
summary: Retrieve a list of api keys
|
||
|
|
responses:
|
||
|
|
200:
|
||
|
|
description: A list of api keys was retrieved successfully
|
||
|
|
headers:
|
||
|
|
Rate-Limit-Limit:
|
||
|
|
$ref: "#/headers/Rate-Limit-Limit"
|
||
|
|
```
|