Added the Rate Limiting headers (#7)
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>
This commit was merged in pull request #7.
This commit is contained in:
@@ -1 +1 @@
|
||||
{"hierarchy":{"paths":[["doc:\/\/DiscogsService\/documentation\/DiscogsService"]]},"primaryContentSections":[{"declarations":[{"tokens":[{"text":"enum","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Servers","kind":"identifier"}],"languages":["swift"],"platforms":["macOS"]}],"kind":"declarations"}],"metadata":{"symbolKind":"enum","navigatorTitle":[{"text":"Servers","kind":"identifier"}],"modules":[{"name":"DiscogsService"}],"roleHeading":"Enumeration","role":"symbol","fragments":[{"text":"enum","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Servers","kind":"identifier"}],"externalID":"s:14DiscogsService7ServersO","title":"Servers"},"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/discogsservice\/servers"]}],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Servers"},"abstract":[{"text":"Server URLs defined in the OpenAPI document.","type":"text"}],"topicSections":[{"identifiers":["doc:\/\/DiscogsService\/documentation\/DiscogsService\/Servers\/server1()"],"generated":true,"title":"Type Methods","anchor":"Type-Methods"},{"identifiers":["doc:\/\/DiscogsService\/documentation\/DiscogsService\/Servers\/Server1"],"generated":true,"title":"Enumerations","anchor":"Enumerations"}],"seeAlsoSections":[{"identifiers":["doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations"],"generated":true,"title":"Types","anchor":"Types"}],"sections":[],"schemaVersion":{"patch":0,"major":0,"minor":3},"kind":"symbol","references":{"doc://DiscogsService/documentation/DiscogsService/Servers":{"title":"Servers","kind":"symbol","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Servers","abstract":[{"type":"text","text":"Server URLs defined in the OpenAPI document."}],"navigatorTitle":[{"text":"Servers","kind":"identifier"}],"fragments":[{"text":"enum","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Servers","kind":"identifier"}],"role":"symbol","type":"topic","url":"\/documentation\/discogsservice\/servers"},"doc://DiscogsService/documentation/DiscogsService":{"title":"DiscogsService","role":"collection","abstract":[],"kind":"symbol","type":"topic","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService","url":"\/documentation\/discogsservice"},"doc://DiscogsService/documentation/DiscogsService/Servers/Server1":{"type":"topic","kind":"symbol","navigatorTitle":[{"text":"Server1","kind":"identifier"}],"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Servers\/Server1","abstract":[{"text":"Live Server","type":"text"}],"role":"symbol","url":"\/documentation\/discogsservice\/servers\/server1","fragments":[{"text":"enum","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Server1","kind":"identifier"}],"title":"Servers.Server1"},"doc://DiscogsService/documentation/DiscogsService/Operations":{"type":"topic","title":"Operations","navigatorTitle":[{"text":"Operations","kind":"identifier"}],"abstract":[{"type":"text","text":"API operations, with input and output types, generated from "},{"type":"codeVoice","code":"#\/paths"},{"type":"text","text":" in the OpenAPI document."}],"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations","role":"symbol","url":"\/documentation\/discogsservice\/operations","fragments":[{"text":"enum","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Operations","kind":"identifier"}],"kind":"symbol"},"doc://DiscogsService/documentation/DiscogsService/Servers/server1()":{"type":"topic","kind":"symbol","deprecated":true,"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Servers\/server1()","abstract":[{"text":"Live Server","type":"text"}],"role":"symbol","url":"\/documentation\/discogsservice\/servers\/server1()","fragments":[{"text":"static","kind":"keyword"},{"text":" ","kind":"text"},{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"server1","kind":"identifier"},{"text":"() ","kind":"text"},{"text":"throws","kind":"keyword"},{"text":" -> ","kind":"text"},{"text":"URL","preciseIdentifier":"s:10Foundation3URLV","kind":"typeIdentifier"}],"title":"server1()"},"doc://DiscogsService/documentation/DiscogsService/Components":{"role":"symbol","title":"Components","kind":"symbol","type":"topic","abstract":[{"type":"text","text":"Types generated from the components section of the OpenAPI document."}],"navigatorTitle":[{"kind":"identifier","text":"Components"}],"url":"\/documentation\/discogsservice\/components","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components","fragments":[{"kind":"keyword","text":"enum"},{"text":" ","kind":"text"},{"kind":"identifier","text":"Components"}]}}}
|
||||
{"sections":[],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Servers"},"metadata":{"navigatorTitle":[{"kind":"identifier","text":"Servers"}],"role":"symbol","externalID":"s:14DiscogsService7ServersO","title":"Servers","symbolKind":"enum","modules":[{"name":"DiscogsService"}],"fragments":[{"kind":"keyword","text":"enum"},{"kind":"text","text":" "},{"text":"Servers","kind":"identifier"}],"roleHeading":"Enumeration"},"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"kind":"keyword","text":"enum"},{"kind":"text","text":" "},{"kind":"identifier","text":"Servers"}],"platforms":["macOS"],"languages":["swift"]}]}],"variants":[{"paths":["\/documentation\/discogsservice\/servers"],"traits":[{"interfaceLanguage":"swift"}]}],"kind":"symbol","abstract":[{"text":"Server URLs defined in the OpenAPI document.","type":"text"}],"hierarchy":{"paths":[["doc:\/\/DiscogsService\/documentation\/DiscogsService"]]},"seeAlsoSections":[{"title":"Types","generated":true,"anchor":"Types","identifiers":["doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations"]}],"schemaVersion":{"minor":3,"patch":0,"major":0},"topicSections":[{"title":"Type Methods","identifiers":["doc:\/\/DiscogsService\/documentation\/DiscogsService\/Servers\/server1()"],"anchor":"Type-Methods","generated":true},{"title":"Enumerations","identifiers":["doc:\/\/DiscogsService\/documentation\/DiscogsService\/Servers\/Server1"],"anchor":"Enumerations","generated":true}],"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/Servers":{"title":"Servers","fragments":[{"kind":"keyword","text":"enum"},{"kind":"text","text":" "},{"kind":"identifier","text":"Servers"}],"type":"topic","url":"\/documentation\/discogsservice\/servers","role":"symbol","navigatorTitle":[{"kind":"identifier","text":"Servers"}],"abstract":[{"type":"text","text":"Server URLs defined in the OpenAPI document."}],"kind":"symbol","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Servers"},"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/Operations":{"kind":"symbol","abstract":[{"type":"text","text":"API operations, with input and output types, generated from "},{"code":"#\/paths","type":"codeVoice"},{"type":"text","text":" in the OpenAPI document."}],"fragments":[{"kind":"keyword","text":"enum"},{"kind":"text","text":" "},{"kind":"identifier","text":"Operations"}],"type":"topic","url":"\/documentation\/discogsservice\/operations","role":"symbol","navigatorTitle":[{"kind":"identifier","text":"Operations"}],"title":"Operations","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations"},"doc://DiscogsService/documentation/DiscogsService/Servers/server1()":{"kind":"symbol","role":"symbol","deprecated":true,"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Servers\/server1()","fragments":[{"text":"static","kind":"keyword"},{"kind":"text","text":" "},{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"server1"},{"kind":"text","text":"() "},{"kind":"keyword","text":"throws"},{"kind":"text","text":" -> "},{"preciseIdentifier":"s:10Foundation3URLV","kind":"typeIdentifier","text":"URL"}],"type":"topic","url":"\/documentation\/discogsservice\/servers\/server1()","title":"server1()","abstract":[{"type":"text","text":"Live Server"}]},"doc://DiscogsService/documentation/DiscogsService/Servers/Server1":{"url":"\/documentation\/discogsservice\/servers\/server1","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Servers\/Server1","role":"symbol","navigatorTitle":[{"kind":"identifier","text":"Server1"}],"kind":"symbol","title":"Servers.Server1","abstract":[{"type":"text","text":"Live Server"}],"fragments":[{"kind":"keyword","text":"enum"},{"kind":"text","text":" "},{"kind":"identifier","text":"Server1"}],"type":"topic"}}}
|
||||
Reference in New Issue
Block a user