javier
d01b60e6dd
This PR contains the work done to define the `RateLimit`, `RateLimitRemaining` and the `RateLimitUsed` heades into the Open API specification document, as well as including these headers as part of the response for every existing endpoint declared in the mentioned document. In addition, the `openapi-generator-config` files was also changed to have a different naming strategy. Reviewed-on: #7 Co-authored-by: Javier Cicchelli <javier@rock-n-code.com> Co-committed-by: Javier Cicchelli <javier@rock-n-code.com>
1 line
5.6 KiB
JSON
1 line
5.6 KiB
JSON
{"schemaVersion":{"major":0,"minor":3,"patch":0},"sections":[],"abstract":[{"text":"Types generated from the ","type":"text"},{"type":"codeVoice","code":"#\/components\/headers"},{"type":"text","text":" section of the OpenAPI document."}],"variants":[{"paths":["\/documentation\/discogsservice\/components\/headers"],"traits":[{"interfaceLanguage":"swift"}]}],"identifier":{"url":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Headers","interfaceLanguage":"swift"},"kind":"symbol","primaryContentSections":[{"kind":"declarations","declarations":[{"platforms":["macOS"],"languages":["swift"],"tokens":[{"text":"enum","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"Headers"}]}]}],"metadata":{"role":"symbol","modules":[{"name":"DiscogsService"}],"externalID":"s:14DiscogsService10ComponentsO7HeadersO","fragments":[{"kind":"keyword","text":"enum"},{"kind":"text","text":" "},{"text":"Headers","kind":"identifier"}],"navigatorTitle":[{"text":"Headers","kind":"identifier"}],"symbolKind":"enum","roleHeading":"Enumeration","title":"Components.Headers"},"hierarchy":{"paths":[["doc:\/\/DiscogsService\/documentation\/DiscogsService","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components"]]},"topicSections":[{"identifiers":["doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Headers\/Link","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Headers\/RateLimit","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Headers\/RateLimitRemaining","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Headers\/RateLimitUsed"],"generated":true,"anchor":"Type-Aliases","title":"Type Aliases"}],"references":{"doc://DiscogsService/documentation/DiscogsService/Components/Headers":{"role":"symbol","abstract":[{"text":"Types generated from the ","type":"text"},{"code":"#\/components\/headers","type":"codeVoice"},{"text":" section of the OpenAPI document.","type":"text"}],"type":"topic","kind":"symbol","url":"\/documentation\/discogsservice\/components\/headers","fragments":[{"text":"enum","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Headers","kind":"identifier"}],"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Headers","navigatorTitle":[{"text":"Headers","kind":"identifier"}],"title":"Components.Headers"},"doc://DiscogsService/documentation/DiscogsService/Components/Headers/Link":{"role":"symbol","abstract":[{"text":"Contains URLs for pagination, compliant with RFC 5988.","type":"text"}],"type":"topic","kind":"symbol","url":"\/documentation\/discogsservice\/components\/headers\/link","fragments":[{"text":"typealias","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Link","kind":"identifier"}],"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Headers\/Link","navigatorTitle":[{"text":"Link","kind":"identifier"}],"title":"Components.Headers.Link"},"doc://DiscogsService/documentation/DiscogsService/Components":{"url":"\/documentation\/discogsservice\/components","title":"Components","role":"symbol","abstract":[{"type":"text","text":"Types generated from the components section of the OpenAPI document."}],"type":"topic","fragments":[{"kind":"keyword","text":"enum"},{"text":" ","kind":"text"},{"text":"Components","kind":"identifier"}],"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components","navigatorTitle":[{"kind":"identifier","text":"Components"}],"kind":"symbol"},"doc://DiscogsService/documentation/DiscogsService/Components/Headers/RateLimitUsed":{"type":"topic","url":"\/documentation\/discogsservice\/components\/headers\/ratelimitused","abstract":[{"text":"A number of requests that have been made in an existing rate limit window.","type":"text"}],"title":"Components.Headers.RateLimitUsed","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Headers\/RateLimitUsed","kind":"symbol","role":"symbol","fragments":[{"kind":"keyword","text":"typealias"},{"kind":"text","text":" "},{"kind":"identifier","text":"RateLimitUsed"}],"navigatorTitle":[{"kind":"identifier","text":"RateLimitUsed"}]},"doc://DiscogsService/documentation/DiscogsService":{"title":"DiscogsService","url":"\/documentation\/discogsservice","type":"topic","role":"collection","abstract":[],"kind":"symbol","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService"},"doc://DiscogsService/documentation/DiscogsService/Components/Headers/RateLimit":{"type":"topic","url":"\/documentation\/discogsservice\/components\/headers\/ratelimit","abstract":[{"text":"A total number of requests that can be made in a minute window.","type":"text"}],"title":"Components.Headers.RateLimit","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Headers\/RateLimit","kind":"symbol","role":"symbol","fragments":[{"text":"typealias","kind":"keyword"},{"text":" ","kind":"text"},{"text":"RateLimit","kind":"identifier"}],"navigatorTitle":[{"text":"RateLimit","kind":"identifier"}]},"doc://DiscogsService/documentation/DiscogsService/Components/Headers/RateLimitRemaining":{"type":"topic","url":"\/documentation\/discogsservice\/components\/headers\/ratelimitremaining","abstract":[{"text":"A number of remaining requests that can be made in an existing rate limit window.","type":"text"}],"title":"Components.Headers.RateLimitRemaining","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Headers\/RateLimitRemaining","kind":"symbol","role":"symbol","fragments":[{"kind":"keyword","text":"typealias"},{"kind":"text","text":" "},{"kind":"identifier","text":"RateLimitRemaining"}],"navigatorTitle":[{"kind":"identifier","text":"RateLimitRemaining"}]}}} |