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
File diff suppressed because one or more lines are too long
@@ -1 +1 @@
{"metadata":{"modules":[{"name":"DiscogsService"}],"role":"collectionGroup","title":"Equatable Implementations","roleHeading":"API Collection"},"sections":[],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/getMasterVersions\/Input\/Path-swift.struct\/Equatable-Implementations"},"topicSections":[{"generated":true,"identifiers":["doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/getMasterVersions\/Input\/Path-swift.struct\/!=(_:_:)"],"title":"Operators","anchor":"Operators"}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/discogsservice\/operations\/getmasterversions\/input\/path-swift.struct\/equatable-implementations"]}],"schemaVersion":{"major":0,"patch":0,"minor":3},"kind":"article","hierarchy":{"paths":[["doc:\/\/DiscogsService\/documentation\/DiscogsService","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/getMasterVersions","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/getMasterVersions\/Input","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/getMasterVersions\/Input\/Path-swift.struct"]]},"references":{"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/Operations/getMasterVersions":{"abstract":[{"type":"text","text":"Get information about the versions of a master release."}],"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/getMasterVersions","type":"topic","kind":"symbol","url":"\/documentation\/discogsservice\/operations\/getmasterversions","role":"symbol","navigatorTitle":[{"text":"getMasterVersions","kind":"identifier"}],"fragments":[{"text":"enum","kind":"keyword"},{"text":" ","kind":"text"},{"text":"getMasterVersions","kind":"identifier"}],"title":"Operations.getMasterVersions"},"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/Operations/getMasterVersions/Input/Path-swift.struct":{"type":"topic","kind":"symbol","navigatorTitle":[{"text":"Path","kind":"identifier"}],"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/getMasterVersions\/Input\/Path-swift.struct","abstract":[],"role":"symbol","url":"\/documentation\/discogsservice\/operations\/getmasterversions\/input\/path-swift.struct","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Path","kind":"identifier"}],"title":"Operations.getMasterVersions.Input.Path"},"doc://DiscogsService/documentation/DiscogsService/Operations/getMasterVersions/Input":{"navigatorTitle":[{"text":"Input","kind":"identifier"}],"role":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"text":" ","kind":"text"},{"text":"Input","kind":"identifier"}],"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/getMasterVersions\/Input","title":"Operations.getMasterVersions.Input","abstract":[],"type":"topic","kind":"symbol","url":"\/documentation\/discogsservice\/operations\/getmasterversions\/input"},"doc://DiscogsService/documentation/DiscogsService/Operations/getMasterVersions/Input/Path-swift.struct/!=(_:_:)":{"type":"topic","kind":"symbol","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/getMasterVersions\/Input\/Path-swift.struct\/!=(_:_:)","abstract":[{"type":"text","text":"Returns a Boolean value indicating whether two values are not equal."}],"role":"symbol","url":"\/documentation\/discogsservice\/operations\/getmasterversions\/input\/path-swift.struct\/!=(_:_:)","fragments":[{"text":"static","kind":"keyword"},{"text":" ","kind":"text"},{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"!=","kind":"identifier"},{"text":" ","kind":"text"},{"text":"(","kind":"text"},{"text":"Self","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"Self","kind":"typeIdentifier"},{"text":") -> ","kind":"text"},{"text":"Bool","kind":"typeIdentifier","preciseIdentifier":"s:Sb"}],"title":"!=(_:_:)"}}}
{"hierarchy":{"paths":[["doc:\/\/DiscogsService\/documentation\/DiscogsService","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetMasterVersions","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetMasterVersions\/Input","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetMasterVersions\/Input\/Path-swift.struct"]]},"topicSections":[{"anchor":"Operators","title":"Operators","generated":true,"identifiers":["doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetMasterVersions\/Input\/Path-swift.struct\/!=(_:_:)"]}],"schemaVersion":{"major":0,"patch":0,"minor":3},"kind":"article","metadata":{"title":"Equatable Implementations","modules":[{"name":"DiscogsService"}],"roleHeading":"API Collection","role":"collectionGroup"},"sections":[],"identifier":{"url":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetMasterVersions\/Input\/Path-swift.struct\/Equatable-Implementations","interfaceLanguage":"swift"},"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/discogsservice\/operations\/getmasterversions\/input\/path-swift.struct\/equatable-implementations"]}],"references":{"doc://DiscogsService/documentation/DiscogsService/Operations/GetMasterVersions/Input/Path-swift.struct":{"role":"symbol","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"Path"}],"kind":"symbol","title":"Operations.GetMasterVersions.Input.Path","type":"topic","navigatorTitle":[{"text":"Path","kind":"identifier"}],"url":"\/documentation\/discogsservice\/operations\/getmasterversions\/input\/path-swift.struct","abstract":[],"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetMasterVersions\/Input\/Path-swift.struct"},"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":{"title":"DiscogsService","url":"\/documentation\/discogsservice","type":"topic","role":"collection","abstract":[],"kind":"symbol","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService"},"doc://DiscogsService/documentation/DiscogsService/Operations/GetMasterVersions":{"url":"\/documentation\/discogsservice\/operations\/getmasterversions","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetMasterVersions","role":"symbol","navigatorTitle":[{"kind":"identifier","text":"GetMasterVersions"}],"kind":"symbol","title":"Operations.GetMasterVersions","abstract":[{"text":"Get information about the versions of a master release.","type":"text"}],"fragments":[{"kind":"keyword","text":"enum"},{"kind":"text","text":" "},{"kind":"identifier","text":"GetMasterVersions"}],"type":"topic"},"doc://DiscogsService/documentation/DiscogsService/Operations/GetMasterVersions/Input":{"url":"\/documentation\/discogsservice\/operations\/getmasterversions\/input","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetMasterVersions\/Input","role":"symbol","navigatorTitle":[{"kind":"identifier","text":"Input"}],"kind":"symbol","title":"Operations.GetMasterVersions.Input","abstract":[],"fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"Input"}],"type":"topic"},"doc://DiscogsService/documentation/DiscogsService/Operations/GetMasterVersions/Input/Path-swift.struct/!=(_:_:)":{"type":"topic","kind":"symbol","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetMasterVersions\/Input\/Path-swift.struct\/!=(_:_:)","fragments":[{"kind":"keyword","text":"static"},{"kind":"text","text":" "},{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"!="},{"kind":"text","text":" "},{"kind":"text","text":"("},{"kind":"typeIdentifier","text":"Self"},{"kind":"text","text":", "},{"kind":"typeIdentifier","text":"Self"},{"kind":"text","text":") -> "},{"preciseIdentifier":"s:Sb","kind":"typeIdentifier","text":"Bool"}],"title":"!=(_:_:)","role":"symbol","abstract":[{"type":"text","text":"Returns a Boolean value indicating whether two values are not equal."}],"url":"\/documentation\/discogsservice\/operations\/getmasterversions\/input\/path-swift.struct\/!=(_:_:)"}}}
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long