valitydev/swag-analytics
14
0
Fork 0
mirror of https://github.com/valitydev/swag-analytics.git synced 2024-11-06 08:45:28 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity
update/default
swag-analytics/spec/README.md
ndiezel0 6d5fae7dce
CAPI-381: Port SWAG CAPI V3 to SWAG Analytics API (#1) 
* CAPI-381: Port SWAG CAPI V3 to SWAG YAPI

* CAPI-381: Clean up unused definitions

* CAPI-381: Rename YAPI to Dashboard API

* CAPI-381: Remove wsd folder and review fixes

* Update spec/definitions/ContinuationToken.yaml

Co-Authored-By: Andrew Mayorov <a.mayorov@rbkmoney.com>

* CAPI-381: Update rebillyMerge script

* CAPI-381: Change copyright and remove wercker deploy

* CAPI-381: Fix `npm start`

* CAPI-381: Remove ExternalIDConflictError

* CAPI-381: Change error message example to one that can actually occur

* CAPI-381: Remove redundant error description

* CAPI-381: Rename x-rebillyMerge to x-merge-properties

* CAPI-381: Rename dashboard api to analytics api

* CAPI-381: Return copyright

* CAPI-381: Review fix

* CAPI-381: Remove ReadOnly fields

* CAPI-381: Remove `analytics` from paths

* CAPI-381: Correct API description
2019-09-06 17:43:30 +03:00

741 B
Raw Permalink 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"