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