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:
2025-10-13 13:09:10 +00:00
committed by Javier Cicchelli
parent 791ebf4f78
commit d01b60e6dd
2457 changed files with 2215 additions and 1955 deletions
@@ -0,0 +1 @@
{"metadata":{"role":"symbol","roleHeading":"Case","modules":[{"name":"DiscogsService"}],"fragments":[{"kind":"keyword","text":"case"},{"kind":"text","text":" "},{"kind":"identifier","text":"numHave"}],"externalID":"s:14DiscogsService10ComponentsO7SchemasO12ReleaseStatsV10CodingKeysO7numHaveyA2ImF","symbolKind":"case","title":"Components.Schemas.ReleaseStats.CodingKeys.numHave"},"variants":[{"paths":["\/documentation\/discogsservice\/components\/schemas\/releasestats\/codingkeys\/numhave"],"traits":[{"interfaceLanguage":"swift"}]}],"primaryContentSections":[{"declarations":[{"platforms":["macOS"],"languages":["swift"],"tokens":[{"kind":"keyword","text":"case"},{"kind":"text","text":" "},{"kind":"identifier","text":"numHave"}]}],"kind":"declarations"}],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/ReleaseStats\/CodingKeys\/numHave"},"sections":[],"schemaVersion":{"minor":3,"patch":0,"major":0},"kind":"symbol","hierarchy":{"paths":[["doc:\/\/DiscogsService\/documentation\/DiscogsService","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/ReleaseStats","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/ReleaseStats\/CodingKeys"]]},"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/Components/Schemas/ReleaseStats":{"title":"Components.Schemas.ReleaseStats","url":"\/documentation\/discogsservice\/components\/schemas\/releasestats","role":"symbol","abstract":[{"text":"A type that represents the statistics of a release.","type":"text"}],"type":"topic","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"ReleaseStats"}],"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/ReleaseStats","navigatorTitle":[{"kind":"identifier","text":"ReleaseStats"}],"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/Schemas/ReleaseStats/CodingKeys/numHave":{"type":"topic","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/ReleaseStats\/CodingKeys\/numHave","kind":"symbol","fragments":[{"text":"case","kind":"keyword"},{"text":" ","kind":"text"},{"text":"numHave","kind":"identifier"}],"title":"Components.Schemas.ReleaseStats.CodingKeys.numHave","role":"symbol","url":"\/documentation\/discogsservice\/components\/schemas\/releasestats\/codingkeys\/numhave","abstract":[]},"doc://DiscogsService/documentation/DiscogsService/Components/Schemas/ReleaseStats/CodingKeys":{"title":"Components.Schemas.ReleaseStats.CodingKeys","url":"\/documentation\/discogsservice\/components\/schemas\/releasestats\/codingkeys","role":"symbol","abstract":[],"type":"topic","fragments":[{"kind":"keyword","text":"enum"},{"kind":"text","text":" "},{"kind":"identifier","text":"CodingKeys"}],"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/ReleaseStats\/CodingKeys","navigatorTitle":[{"kind":"identifier","text":"CodingKeys"}],"kind":"symbol"},"doc://DiscogsService/documentation/DiscogsService/Components/Schemas":{"url":"\/documentation\/discogsservice\/components\/schemas","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas","role":"symbol","navigatorTitle":[{"kind":"identifier","text":"Schemas"}],"kind":"symbol","title":"Components.Schemas","abstract":[{"type":"text","text":"Types generated from the "},{"type":"codeVoice","code":"#\/components\/schemas"},{"type":"text","text":" section of the OpenAPI document."}],"fragments":[{"kind":"keyword","text":"enum"},{"kind":"text","text":" "},{"kind":"identifier","text":"Schemas"}],"type":"topic"}}}