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
12 KiB
JSON
1 line
12 KiB
JSON
{"sections":[],"metadata":{"fragments":[{"text":"enum","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"CodingKeys"}],"modules":[{"name":"DiscogsService"}],"symbolKind":"enum","role":"symbol","navigatorTitle":[{"text":"CodingKeys","kind":"identifier"}],"roleHeading":"Enumeration","title":"Components.Schemas.Service.CodingKeys","externalID":"s:14DiscogsService10ComponentsO7SchemasO0B0V10CodingKeysO"},"identifier":{"url":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/Service\/CodingKeys","interfaceLanguage":"swift"},"relationshipsSections":[{"title":"Conforms To","type":"conformsTo","kind":"relationships","identifiers":["doc:\/\/DiscogsService\/s9CodingKeyP","doc:\/\/DiscogsService\/s28CustomDebugStringConvertibleP","doc:\/\/DiscogsService\/s23CustomStringConvertibleP","doc:\/\/DiscogsService\/SQ","doc:\/\/DiscogsService\/SH","doc:\/\/DiscogsService\/SY","doc:\/\/DiscogsService\/s8SendableP","doc:\/\/DiscogsService\/s16SendableMetatypeP"]}],"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"kind":"keyword","text":"enum"},{"kind":"text","text":" "},{"kind":"identifier","text":"CodingKeys"}],"platforms":["macOS"],"languages":["swift"]}]}],"kind":"symbol","variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/discogsservice\/components\/schemas\/service\/codingkeys"]}],"hierarchy":{"paths":[["doc:\/\/DiscogsService\/documentation\/DiscogsService","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/Service"]]},"schemaVersion":{"patch":0,"major":0,"minor":3},"topicSections":[{"identifiers":["doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/Service\/CodingKeys\/apiVersion","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/Service\/CodingKeys\/documentationUrl","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/Service\/CodingKeys\/hello","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/Service\/CodingKeys\/statistics"],"title":"Enumeration Cases","generated":true,"anchor":"Enumeration-Cases"},{"anchor":"Initializers","title":"Initializers","generated":true,"identifiers":["doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/Service\/CodingKeys\/init(intValue:)","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/Service\/CodingKeys\/init(rawValue:)","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/Service\/CodingKeys\/init(stringValue:)"]},{"title":"Default Implementations","generated":true,"anchor":"Default-Implementations","identifiers":["doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/Service\/CodingKeys\/CodingKey-Implementations","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/Service\/CodingKeys\/Equatable-Implementations","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/Service\/CodingKeys\/RawRepresentable-Implementations"]}],"references":{"doc://DiscogsService/SH":{"title":"Swift.Hashable","identifier":"doc:\/\/DiscogsService\/SH","type":"unresolvable"},"doc://DiscogsService/s9CodingKeyP":{"title":"Swift.CodingKey","identifier":"doc:\/\/DiscogsService\/s9CodingKeyP","type":"unresolvable"},"doc://DiscogsService/s28CustomDebugStringConvertibleP":{"title":"Swift.CustomDebugStringConvertible","identifier":"doc:\/\/DiscogsService\/s28CustomDebugStringConvertibleP","type":"unresolvable"},"doc://DiscogsService/SQ":{"title":"Swift.Equatable","type":"unresolvable","identifier":"doc:\/\/DiscogsService\/SQ"},"doc://DiscogsService/s16SendableMetatypeP":{"title":"Swift.SendableMetatype","type":"unresolvable","identifier":"doc:\/\/DiscogsService\/s16SendableMetatypeP"},"doc://DiscogsService/documentation/DiscogsService/Components/Schemas/Service/CodingKeys/statistics":{"kind":"symbol","abstract":[],"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/Service\/CodingKeys\/statistics","type":"topic","role":"symbol","fragments":[{"kind":"keyword","text":"case"},{"text":" ","kind":"text"},{"kind":"identifier","text":"statistics"}],"title":"Components.Schemas.Service.CodingKeys.statistics","url":"\/documentation\/discogsservice\/components\/schemas\/service\/codingkeys\/statistics"},"doc://DiscogsService/SY":{"title":"Swift.RawRepresentable","type":"unresolvable","identifier":"doc:\/\/DiscogsService\/SY"},"doc://DiscogsService/s8SendableP":{"title":"Swift.Sendable","type":"unresolvable","identifier":"doc:\/\/DiscogsService\/s8SendableP"},"doc://DiscogsService/documentation/DiscogsService/Components/Schemas/Service/CodingKeys/documentationUrl":{"type":"topic","title":"Components.Schemas.Service.CodingKeys.documentationUrl","abstract":[],"url":"\/documentation\/discogsservice\/components\/schemas\/service\/codingkeys\/documentationurl","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/Service\/CodingKeys\/documentationUrl","kind":"symbol","role":"symbol","fragments":[{"text":"case","kind":"keyword"},{"text":" ","kind":"text"},{"text":"documentationUrl","kind":"identifier"}]},"doc://DiscogsService/documentation/DiscogsService/Components/Schemas/Service/CodingKeys/init(stringValue:)":{"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/Service\/CodingKeys\/init(stringValue:)","kind":"symbol","fragments":[{"kind":"identifier","text":"init"},{"kind":"text","text":"?("},{"kind":"externalParam","text":"stringValue"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"text":")","kind":"text"}],"type":"topic","url":"\/documentation\/discogsservice\/components\/schemas\/service\/codingkeys\/init(stringvalue:)","role":"symbol","title":"init(stringValue:)","abstract":[]},"doc://DiscogsService/documentation/DiscogsService/Components/Schemas/Service/CodingKeys/apiVersion":{"title":"Components.Schemas.Service.CodingKeys.apiVersion","fragments":[{"kind":"keyword","text":"case"},{"kind":"text","text":" "},{"text":"apiVersion","kind":"identifier"}],"type":"topic","url":"\/documentation\/discogsservice\/components\/schemas\/service\/codingkeys\/apiversion","role":"symbol","abstract":[],"kind":"symbol","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/Service\/CodingKeys\/apiVersion"},"doc://DiscogsService/documentation/DiscogsService/Components/Schemas/Service":{"url":"\/documentation\/discogsservice\/components\/schemas\/service","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/Service","role":"symbol","navigatorTitle":[{"kind":"identifier","text":"Service"}],"kind":"symbol","title":"Components.Schemas.Service","abstract":[{"text":"A type that encapsulates any available information about the service.","type":"text"}],"fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"Service"}],"type":"topic"},"doc://DiscogsService/documentation/DiscogsService/Components/Schemas/Service/CodingKeys/Equatable-Implementations":{"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/Service\/CodingKeys\/Equatable-Implementations","kind":"article","type":"topic","url":"\/documentation\/discogsservice\/components\/schemas\/service\/codingkeys\/equatable-implementations","role":"collectionGroup","title":"Equatable Implementations","abstract":[]},"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/Service/CodingKeys/init(intValue:)":{"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/Service\/CodingKeys\/init(intValue:)","kind":"symbol","fragments":[{"text":"init","kind":"identifier"},{"text":"?(","kind":"text"},{"text":"intValue","kind":"externalParam"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:Si","text":"Int"},{"kind":"text","text":")"}],"type":"topic","url":"\/documentation\/discogsservice\/components\/schemas\/service\/codingkeys\/init(intvalue:)","role":"symbol","title":"init(intValue:)","abstract":[]},"doc://DiscogsService/documentation/DiscogsService/Components/Schemas/Service/CodingKeys/hello":{"kind":"symbol","role":"symbol","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/Service\/CodingKeys\/hello","fragments":[{"kind":"keyword","text":"case"},{"kind":"text","text":" "},{"text":"hello","kind":"identifier"}],"url":"\/documentation\/discogsservice\/components\/schemas\/service\/codingkeys\/hello","type":"topic","title":"Components.Schemas.Service.CodingKeys.hello","abstract":[]},"doc://DiscogsService/documentation/DiscogsService":{"title":"DiscogsService","url":"\/documentation\/discogsservice","type":"topic","role":"collection","abstract":[],"kind":"symbol","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService"},"doc://DiscogsService/s23CustomStringConvertibleP":{"type":"unresolvable","title":"Swift.CustomStringConvertible","identifier":"doc:\/\/DiscogsService\/s23CustomStringConvertibleP"},"doc://DiscogsService/documentation/DiscogsService/Components/Schemas/Service/CodingKeys/init(rawValue:)":{"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/Service\/CodingKeys\/init(rawValue:)","kind":"symbol","fragments":[{"text":"init","kind":"identifier"},{"text":"?(","kind":"text"},{"text":"rawValue","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":")","kind":"text"}],"type":"topic","url":"\/documentation\/discogsservice\/components\/schemas\/service\/codingkeys\/init(rawvalue:)","role":"symbol","title":"init(rawValue:)","abstract":[]},"doc://DiscogsService/documentation/DiscogsService/Components/Schemas/Service/CodingKeys/RawRepresentable-Implementations":{"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/Service\/CodingKeys\/RawRepresentable-Implementations","kind":"article","type":"topic","url":"\/documentation\/discogsservice\/components\/schemas\/service\/codingkeys\/rawrepresentable-implementations","role":"collectionGroup","title":"RawRepresentable Implementations","abstract":[]},"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"},"doc://DiscogsService/documentation/DiscogsService/Components/Schemas/Service/CodingKeys":{"url":"\/documentation\/discogsservice\/components\/schemas\/service\/codingkeys","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/Service\/CodingKeys","role":"symbol","navigatorTitle":[{"text":"CodingKeys","kind":"identifier"}],"kind":"symbol","title":"Components.Schemas.Service.CodingKeys","abstract":[],"fragments":[{"kind":"keyword","text":"enum"},{"kind":"text","text":" "},{"text":"CodingKeys","kind":"identifier"}],"type":"topic"},"doc://DiscogsService/documentation/DiscogsService/Components/Schemas/Service/CodingKeys/CodingKey-Implementations":{"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/Service\/CodingKeys\/CodingKey-Implementations","kind":"article","type":"topic","url":"\/documentation\/discogsservice\/components\/schemas\/service\/codingkeys\/codingkey-implementations","role":"collectionGroup","title":"CodingKey Implementations","abstract":[]}}} |