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","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Servers"]]},"primaryContentSections":[{"declarations":[{"platforms":["macOS"],"tokens":[{"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","kind":"typeIdentifier","preciseIdentifier":"s:10Foundation3URLV"}],"languages":["swift"]}],"kind":"declarations"}],"metadata":{"platforms":[{"beta":false,"renamed":"Servers.Server1.url","unavailable":false,"deprecated":true}],"externalID":"s:14DiscogsService7ServersO7server110Foundation3URLVyKFZ","role":"symbol","symbolKind":"method","roleHeading":"Type Method","modules":[{"name":"DiscogsService"}],"fragments":[{"text":"static","kind":"keyword"},{"text":" ","kind":"text"},{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"server1","kind":"identifier"},{"text":"() ","kind":"text"},{"kind":"keyword","text":"throws"},{"kind":"text","text":" -> "},{"text":"URL","kind":"typeIdentifier","preciseIdentifier":"s:10Foundation3URLV"}],"title":"server1()"},"variants":[{"paths":["\/documentation\/discogsservice\/servers\/server1()"],"traits":[{"interfaceLanguage":"swift"}]}],"identifier":{"url":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Servers\/server1()","interfaceLanguage":"swift"},"abstract":[{"type":"text","text":"Live Server"}],"sections":[],"schemaVersion":{"minor":3,"major":0,"patch":0},"kind":"symbol","references":{"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":{"title":"DiscogsService","role":"collection","abstract":[],"kind":"symbol","type":"topic","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService","url":"\/documentation\/discogsservice"},"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"}}}
|
||||
{"sections":[],"schemaVersion":{"major":0,"minor":3,"patch":0},"kind":"symbol","hierarchy":{"paths":[["doc:\/\/DiscogsService\/documentation\/DiscogsService","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Servers"]]},"metadata":{"platforms":[{"unavailable":false,"beta":false,"deprecated":true,"renamed":"Servers.Server1.url"}],"role":"symbol","roleHeading":"Type Method","modules":[{"name":"DiscogsService"}],"fragments":[{"text":"static","kind":"keyword"},{"kind":"text","text":" "},{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"text":"server1","kind":"identifier"},{"kind":"text","text":"() "},{"text":"throws","kind":"keyword"},{"kind":"text","text":" -> "},{"kind":"typeIdentifier","text":"URL","preciseIdentifier":"s:10Foundation3URLV"}],"externalID":"s:14DiscogsService7ServersO7server110Foundation3URLVyKFZ","symbolKind":"method","title":"server1()"},"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Servers\/server1()"},"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"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":" -> "},{"kind":"typeIdentifier","text":"URL","preciseIdentifier":"s:10Foundation3URLV"}],"languages":["swift"],"platforms":["macOS"]}]}],"variants":[{"paths":["\/documentation\/discogsservice\/servers\/server1()"],"traits":[{"interfaceLanguage":"swift"}]}],"abstract":[{"type":"text","text":"Live Server"}],"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/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":{"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"}}}
|
||||
@@ -1 +1 @@
|
||||
{"abstract":[{"type":"text","text":"Live Server"}],"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"text":"enum","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Server1","kind":"identifier"}],"languages":["swift"],"platforms":["macOS"]}]}],"kind":"symbol","metadata":{"symbolKind":"enum","title":"Servers.Server1","navigatorTitle":[{"text":"Server1","kind":"identifier"}],"roleHeading":"Enumeration","externalID":"s:14DiscogsService7ServersO7Server1O","fragments":[{"text":"enum","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Server1","kind":"identifier"}],"role":"symbol","modules":[{"name":"DiscogsService"}]},"sections":[],"hierarchy":{"paths":[["doc:\/\/DiscogsService\/documentation\/DiscogsService","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Servers"]]},"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Servers\/Server1"},"topicSections":[{"generated":true,"anchor":"Type-Methods","identifiers":["doc:\/\/DiscogsService\/documentation\/DiscogsService\/Servers\/Server1\/url()"],"title":"Type Methods"}],"schemaVersion":{"minor":3,"patch":0,"major":0},"variants":[{"paths":["\/documentation\/discogsservice\/servers\/server1"],"traits":[{"interfaceLanguage":"swift"}]}],"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/Servers/Server1/url()":{"url":"\/documentation\/discogsservice\/servers\/server1\/url()","abstract":[{"type":"text","text":"Live Server"}],"title":"url()","kind":"symbol","type":"topic","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Servers\/Server1\/url()","fragments":[{"kind":"keyword","text":"static"},{"kind":"text","text":" "},{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"url"},{"kind":"text","text":"() "},{"kind":"keyword","text":"throws"},{"kind":"text","text":" -> "},{"kind":"typeIdentifier","preciseIdentifier":"s:10Foundation3URLV","text":"URL"}],"role":"symbol"}}}
|
||||
{"schemaVersion":{"minor":3,"patch":0,"major":0},"sections":[],"abstract":[{"type":"text","text":"Live Server"}],"variants":[{"paths":["\/documentation\/discogsservice\/servers\/server1"],"traits":[{"interfaceLanguage":"swift"}]}],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Servers\/Server1"},"kind":"symbol","primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"kind":"keyword","text":"enum"},{"kind":"text","text":" "},{"kind":"identifier","text":"Server1"}],"platforms":["macOS"],"languages":["swift"]}]}],"metadata":{"roleHeading":"Enumeration","symbolKind":"enum","externalID":"s:14DiscogsService7ServersO7Server1O","modules":[{"name":"DiscogsService"}],"navigatorTitle":[{"kind":"identifier","text":"Server1"}],"role":"symbol","fragments":[{"kind":"keyword","text":"enum"},{"kind":"text","text":" "},{"kind":"identifier","text":"Server1"}],"title":"Servers.Server1"},"hierarchy":{"paths":[["doc:\/\/DiscogsService\/documentation\/DiscogsService","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Servers"]]},"topicSections":[{"title":"Type Methods","identifiers":["doc:\/\/DiscogsService\/documentation\/DiscogsService\/Servers\/Server1\/url()"],"generated":true,"anchor":"Type-Methods"}],"references":{"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"},"doc://DiscogsService/documentation/DiscogsService/Servers/Server1/url()":{"kind":"symbol","role":"symbol","type":"topic","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Servers\/Server1\/url()","abstract":[{"text":"Live Server","type":"text"}],"fragments":[{"text":"static","kind":"keyword"},{"text":" ","kind":"text"},{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"url","kind":"identifier"},{"text":"() ","kind":"text"},{"text":"throws","kind":"keyword"},{"text":" -> ","kind":"text"},{"text":"URL","preciseIdentifier":"s:10Foundation3URLV","kind":"typeIdentifier"}],"title":"url()","url":"\/documentation\/discogsservice\/servers\/server1\/url()"},"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/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"}}}
|
||||
@@ -1 +1 @@
|
||||
{"metadata":{"roleHeading":"Type Method","role":"symbol","externalID":"s:14DiscogsService7ServersO7Server1O3url10Foundation3URLVyKFZ","title":"url()","fragments":[{"text":"static","kind":"keyword"},{"text":" ","kind":"text"},{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"url","kind":"identifier"},{"text":"() ","kind":"text"},{"text":"throws","kind":"keyword"},{"text":" -> ","kind":"text"},{"text":"URL","preciseIdentifier":"s:10Foundation3URLV","kind":"typeIdentifier"}],"symbolKind":"method","modules":[{"name":"DiscogsService"}]},"primaryContentSections":[{"kind":"declarations","declarations":[{"platforms":["macOS"],"tokens":[{"text":"static","kind":"keyword"},{"text":" ","kind":"text"},{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"url","kind":"identifier"},{"text":"() ","kind":"text"},{"text":"throws","kind":"keyword"},{"text":" -> ","kind":"text"},{"text":"URL","preciseIdentifier":"s:10Foundation3URLV","kind":"typeIdentifier"}],"languages":["swift"]}]}],"sections":[],"identifier":{"url":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Servers\/Server1\/url()","interfaceLanguage":"swift"},"abstract":[{"type":"text","text":"Live Server"}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/discogsservice\/servers\/server1\/url()"]}],"schemaVersion":{"patch":0,"major":0,"minor":3},"kind":"symbol","hierarchy":{"paths":[["doc:\/\/DiscogsService\/documentation\/DiscogsService","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Servers","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Servers\/Server1"]]},"references":{"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/Servers/Server1/url()":{"url":"\/documentation\/discogsservice\/servers\/server1\/url()","abstract":[{"type":"text","text":"Live Server"}],"title":"url()","kind":"symbol","type":"topic","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Servers\/Server1\/url()","fragments":[{"kind":"keyword","text":"static"},{"kind":"text","text":" "},{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"url"},{"kind":"text","text":"() "},{"kind":"keyword","text":"throws"},{"kind":"text","text":" -> "},{"kind":"typeIdentifier","preciseIdentifier":"s:10Foundation3URLV","text":"URL"}],"role":"symbol"},"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":{"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"}}}
|
||||
{"primaryContentSections":[{"declarations":[{"tokens":[{"text":"static","kind":"keyword"},{"text":" ","kind":"text"},{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"url","kind":"identifier"},{"text":"() ","kind":"text"},{"text":"throws","kind":"keyword"},{"text":" -> ","kind":"text"},{"preciseIdentifier":"s:10Foundation3URLV","text":"URL","kind":"typeIdentifier"}],"platforms":["macOS"],"languages":["swift"]}],"kind":"declarations"}],"schemaVersion":{"minor":3,"patch":0,"major":0},"sections":[],"kind":"symbol","identifier":{"url":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Servers\/Server1\/url()","interfaceLanguage":"swift"},"metadata":{"role":"symbol","externalID":"s:14DiscogsService7ServersO7Server1O3url10Foundation3URLVyKFZ","roleHeading":"Type Method","title":"url()","symbolKind":"method","modules":[{"name":"DiscogsService"}],"fragments":[{"text":"static","kind":"keyword"},{"text":" ","kind":"text"},{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"url","kind":"identifier"},{"text":"() ","kind":"text"},{"text":"throws","kind":"keyword"},{"text":" -> ","kind":"text"},{"preciseIdentifier":"s:10Foundation3URLV","text":"URL","kind":"typeIdentifier"}]},"abstract":[{"text":"Live Server","type":"text"}],"hierarchy":{"paths":[["doc:\/\/DiscogsService\/documentation\/DiscogsService","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Servers","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Servers\/Server1"]]},"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/discogsservice\/servers\/server1\/url()"]}],"references":{"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"},"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/Servers/Server1/url()":{"kind":"symbol","role":"symbol","type":"topic","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Servers\/Server1\/url()","abstract":[{"text":"Live Server","type":"text"}],"fragments":[{"text":"static","kind":"keyword"},{"text":" ","kind":"text"},{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"url","kind":"identifier"},{"text":"() ","kind":"text"},{"text":"throws","kind":"keyword"},{"text":" -> ","kind":"text"},{"text":"URL","preciseIdentifier":"s:10Foundation3URLV","kind":"typeIdentifier"}],"title":"url()","url":"\/documentation\/discogsservice\/servers\/server1\/url()"}}}
|
||||
Reference in New Issue
Block a user