valitydev/swag-webhook-events
14
0
Fork 0
mirror of https://github.com/valitydev/swag-webhook-events.git synced 2024-11-06 10:25:17 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity
f0efab9c0e
swag-webhook-events/spec/README.md
Anton Kuranda 630d1e7cb8 Redoc ready fix (#2) 
* HOOK-11: Initial webhook events swagger commit

* fix .gitignore

* hotfix

* added signature header

* fix

* fix

* fixed after some comments (not at all)

* fixed after other comments

* fixed doc about retry policy

* Fixed camelCase

* Fixed

* fixed

* added amount minimum

* removed host

* fixed minor bug

* added payload to required fields

* added partyId

* added description about queue policy

* fix resend policy depends of http-code

* removed x-request-id header

* -added ReDoc infrastructure
- completely reformat spec structure

* added gitignore

* forgot to add gitignore, removed node_modules

* readme fix

* removed web_deploy

* removed unnecessary wsd

* changed eventid type

* review fix #1

* wording fix, build fix
2017-04-25 17:44:38 +03:00

741 B
Raw Blame History

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"