valitydev/swag-payments
14
0
Fork 0
mirror of https://github.com/valitydev/swag-payments.git synced 2024-11-06 17:45:24 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity
fb18643a35
swag-payments/spec
History
Evgeny Levenets fb18643a35
MST-173: replace offset with continuation token (#212) 
* replace offset and total count with continuation token for magista-related requests
* add payment status timestamp
* offset is still presented in "searchPayouts" request
2018-07-11 16:07:01 +03:00
..
code_samples ITS-21: Prepare for the release (#31) 2017-02-06 15:09:03 +03:00
definitions MST-173: replace offset with continuation token (#212) 2018-07-11 16:07:01 +03:00
paths MST-173: replace offset with continuation token (#212) 2018-07-11 16:07:01 +03:00
wsd general grammar fixes (#36) 2017-02-06 20:15:39 +03:00
README.md ITS-21: Prepare for the release (#31) 2017-02-06 15:09:03 +03:00
swagger.yaml - added 'timeout' error description (#208) 2018-06-05 16:55:40 +03:00

README.md

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:

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