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
3.9 KiB
JSON
1 line
3.9 KiB
JSON
{"identifier":{"url":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Headers\/RateLimitRemaining","interfaceLanguage":"swift"},"abstract":[{"text":"A number of remaining requests that can be made in an existing rate limit window.","type":"text"}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/discogsservice\/components\/headers\/ratelimitremaining"]}],"metadata":{"role":"symbol","title":"Components.Headers.RateLimitRemaining","roleHeading":"Type Alias","symbolKind":"typealias","fragments":[{"text":"typealias","kind":"keyword"},{"text":" ","kind":"text"},{"text":"RateLimitRemaining","kind":"identifier"}],"modules":[{"name":"DiscogsService"}],"navigatorTitle":[{"text":"RateLimitRemaining","kind":"identifier"}],"externalID":"s:14DiscogsService10ComponentsO7HeadersO18RateLimitRemaininga"},"schemaVersion":{"major":0,"minor":3,"patch":0},"kind":"symbol","primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"text":"typealias","kind":"keyword"},{"text":" ","kind":"text"},{"text":"RateLimitRemaining","kind":"identifier"},{"text":" = ","kind":"text"},{"preciseIdentifier":"s:Si","text":"Int","kind":"typeIdentifier"}],"platforms":["macOS"],"languages":["swift"]}]},{"content":[{"text":"Discussion","level":2,"type":"heading","anchor":"discussion"},{"content":[{"inlineContent":[{"type":"text","text":"Generated from "},{"code":"#\/components\/headers\/RateLimitRemaining","type":"codeVoice"},{"type":"text","text":"."}],"type":"paragraph"}],"style":"note","name":"Remark","type":"aside"}],"kind":"content"}],"sections":[],"hierarchy":{"paths":[["doc:\/\/DiscogsService\/documentation\/DiscogsService","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Headers"]]},"references":{"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":{"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":{"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/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"}]}}} |