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
13 KiB
JSON
1 line
13 KiB
JSON
{"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"text":"enum","kind":"keyword"},{"text":" ","kind":"text"},{"text":"CodingKeys","kind":"identifier"}],"languages":["swift"],"platforms":["macOS"]}]}],"sections":[],"kind":"symbol","schemaVersion":{"patch":0,"major":0,"minor":3},"topicSections":[{"identifiers":["doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/Master\/Value2Payload\/CodingKeys\/mainRelease","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/Master\/Value2Payload\/CodingKeys\/mainReleaseUrl","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/Master\/Value2Payload\/CodingKeys\/versionsUrl"],"generated":true,"anchor":"Enumeration-Cases","title":"Enumeration Cases"},{"identifiers":["doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/Master\/Value2Payload\/CodingKeys\/init(intValue:)","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/Master\/Value2Payload\/CodingKeys\/init(rawValue:)","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/Master\/Value2Payload\/CodingKeys\/init(stringValue:)"],"generated":true,"anchor":"Initializers","title":"Initializers"},{"identifiers":["doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/Master\/Value2Payload\/CodingKeys\/CodingKey-Implementations","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/Master\/Value2Payload\/CodingKeys\/Equatable-Implementations","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/Master\/Value2Payload\/CodingKeys\/RawRepresentable-Implementations"],"generated":true,"anchor":"Default-Implementations","title":"Default Implementations"}],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/Master\/Value2Payload\/CodingKeys"},"metadata":{"fragments":[{"text":"enum","kind":"keyword"},{"text":" ","kind":"text"},{"text":"CodingKeys","kind":"identifier"}],"modules":[{"name":"DiscogsService"}],"role":"symbol","symbolKind":"enum","navigatorTitle":[{"text":"CodingKeys","kind":"identifier"}],"roleHeading":"Enumeration","externalID":"s:14DiscogsService10ComponentsO7SchemasO6MasterV13Value2PayloadV10CodingKeysO","title":"Components.Schemas.Master.Value2Payload.CodingKeys"},"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/discogsservice\/components\/schemas\/master\/value2payload\/codingkeys"]}],"hierarchy":{"paths":[["doc:\/\/DiscogsService\/documentation\/DiscogsService","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/Master","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/Master\/Value2Payload"]]},"relationshipsSections":[{"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"],"kind":"relationships","type":"conformsTo","title":"Conforms To"}],"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/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/s16SendableMetatypeP":{"type":"unresolvable","identifier":"doc:\/\/DiscogsService\/s16SendableMetatypeP","title":"Swift.SendableMetatype"},"doc://DiscogsService/documentation/DiscogsService/Components/Schemas/Master/Value2Payload/CodingKeys":{"type":"topic","url":"\/documentation\/discogsservice\/components\/schemas\/master\/value2payload\/codingkeys","title":"Components.Schemas.Master.Value2Payload.CodingKeys","abstract":[],"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/Master\/Value2Payload\/CodingKeys","kind":"symbol","role":"symbol","fragments":[{"kind":"keyword","text":"enum"},{"kind":"text","text":" "},{"kind":"identifier","text":"CodingKeys"}],"navigatorTitle":[{"kind":"identifier","text":"CodingKeys"}]},"doc://DiscogsService/documentation/DiscogsService/Components/Schemas/Master/Value2Payload/CodingKeys/mainRelease":{"title":"Components.Schemas.Master.Value2Payload.CodingKeys.mainRelease","fragments":[{"text":"case","kind":"keyword"},{"text":" ","kind":"text"},{"text":"mainRelease","kind":"identifier"}],"url":"\/documentation\/discogsservice\/components\/schemas\/master\/value2payload\/codingkeys\/mainrelease","type":"topic","role":"symbol","abstract":[],"kind":"symbol","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/Master\/Value2Payload\/CodingKeys\/mainRelease"},"doc://DiscogsService/SH":{"type":"unresolvable","identifier":"doc:\/\/DiscogsService\/SH","title":"Swift.Hashable"},"doc://DiscogsService/s23CustomStringConvertibleP":{"type":"unresolvable","identifier":"doc:\/\/DiscogsService\/s23CustomStringConvertibleP","title":"Swift.CustomStringConvertible"},"doc://DiscogsService/SY":{"type":"unresolvable","identifier":"doc:\/\/DiscogsService\/SY","title":"Swift.RawRepresentable"},"doc://DiscogsService/s8SendableP":{"type":"unresolvable","identifier":"doc:\/\/DiscogsService\/s8SendableP","title":"Swift.Sendable"},"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/Master/Value2Payload/CodingKeys/Equatable-Implementations":{"kind":"article","role":"collectionGroup","type":"topic","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/Master\/Value2Payload\/CodingKeys\/Equatable-Implementations","abstract":[],"url":"\/documentation\/discogsservice\/components\/schemas\/master\/value2payload\/codingkeys\/equatable-implementations","title":"Equatable Implementations"},"doc://DiscogsService/documentation/DiscogsService/Components/Schemas/Master/Value2Payload/CodingKeys/versionsUrl":{"kind":"symbol","role":"symbol","type":"topic","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/Master\/Value2Payload\/CodingKeys\/versionsUrl","abstract":[],"fragments":[{"kind":"keyword","text":"case"},{"kind":"text","text":" "},{"kind":"identifier","text":"versionsUrl"}],"url":"\/documentation\/discogsservice\/components\/schemas\/master\/value2payload\/codingkeys\/versionsurl","title":"Components.Schemas.Master.Value2Payload.CodingKeys.versionsUrl"},"doc://DiscogsService/documentation/DiscogsService/Components/Schemas/Master/Value2Payload":{"url":"\/documentation\/discogsservice\/components\/schemas\/master\/value2payload","type":"topic","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/Master\/Value2Payload","abstract":[],"role":"symbol","navigatorTitle":[{"kind":"identifier","text":"Value2Payload"}],"fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"Value2Payload"}],"title":"Components.Schemas.Master.Value2Payload","kind":"symbol"},"doc://DiscogsService/documentation/DiscogsService/Components/Schemas/Master":{"title":"Components.Schemas.Master","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"Master"}],"type":"topic","url":"\/documentation\/discogsservice\/components\/schemas\/master","role":"symbol","navigatorTitle":[{"kind":"identifier","text":"Master"}],"kind":"symbol","abstract":[{"type":"text","text":"A type that represents a set of similar releases."}],"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/Master"},"doc://DiscogsService/SQ":{"type":"unresolvable","identifier":"doc:\/\/DiscogsService\/SQ","title":"Swift.Equatable"},"doc://DiscogsService/documentation/DiscogsService/Components/Schemas/Master/Value2Payload/CodingKeys/init(rawValue:)":{"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/Master\/Value2Payload\/CodingKeys\/init(rawValue:)","role":"symbol","abstract":[],"fragments":[{"text":"init","kind":"identifier"},{"text":"?(","kind":"text"},{"text":"rawValue","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":")","kind":"text"}],"title":"init(rawValue:)","url":"\/documentation\/discogsservice\/components\/schemas\/master\/value2payload\/codingkeys\/init(rawvalue:)","kind":"symbol","type":"topic"},"doc://DiscogsService/s9CodingKeyP":{"type":"unresolvable","identifier":"doc:\/\/DiscogsService\/s9CodingKeyP","title":"Swift.CodingKey"},"doc://DiscogsService/documentation/DiscogsService/Components/Schemas/Master/Value2Payload/CodingKeys/mainReleaseUrl":{"kind":"symbol","role":"symbol","type":"topic","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/Master\/Value2Payload\/CodingKeys\/mainReleaseUrl","abstract":[],"fragments":[{"kind":"keyword","text":"case"},{"kind":"text","text":" "},{"kind":"identifier","text":"mainReleaseUrl"}],"url":"\/documentation\/discogsservice\/components\/schemas\/master\/value2payload\/codingkeys\/mainreleaseurl","title":"Components.Schemas.Master.Value2Payload.CodingKeys.mainReleaseUrl"},"doc://DiscogsService/documentation/DiscogsService/Components/Schemas/Master/Value2Payload/CodingKeys/RawRepresentable-Implementations":{"kind":"article","role":"collectionGroup","type":"topic","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/Master\/Value2Payload\/CodingKeys\/RawRepresentable-Implementations","abstract":[],"url":"\/documentation\/discogsservice\/components\/schemas\/master\/value2payload\/codingkeys\/rawrepresentable-implementations","title":"RawRepresentable Implementations"},"doc://DiscogsService/documentation/DiscogsService/Components/Schemas/Master/Value2Payload/CodingKeys/init(stringValue:)":{"title":"init(stringValue:)","url":"\/documentation\/discogsservice\/components\/schemas\/master\/value2payload\/codingkeys\/init(stringvalue:)","abstract":[],"type":"topic","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/Master\/Value2Payload\/CodingKeys\/init(stringValue:)","kind":"symbol","role":"symbol","fragments":[{"text":"init","kind":"identifier"},{"kind":"text","text":"?("},{"text":"stringValue","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":")","kind":"text"}]},"doc://DiscogsService/s28CustomDebugStringConvertibleP":{"type":"unresolvable","identifier":"doc:\/\/DiscogsService\/s28CustomDebugStringConvertibleP","title":"Swift.CustomDebugStringConvertible"},"doc://DiscogsService/documentation/DiscogsService/Components/Schemas/Master/Value2Payload/CodingKeys/CodingKey-Implementations":{"kind":"article","role":"collectionGroup","type":"topic","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/Master\/Value2Payload\/CodingKeys\/CodingKey-Implementations","abstract":[],"url":"\/documentation\/discogsservice\/components\/schemas\/master\/value2payload\/codingkeys\/codingkey-implementations","title":"CodingKey Implementations"},"doc://DiscogsService/documentation/DiscogsService/Components/Schemas/Master/Value2Payload/CodingKeys/init(intValue:)":{"kind":"symbol","role":"symbol","type":"topic","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/Master\/Value2Payload\/CodingKeys\/init(intValue:)","abstract":[],"fragments":[{"kind":"identifier","text":"init"},{"kind":"text","text":"?("},{"kind":"externalParam","text":"intValue"},{"kind":"text","text":": "},{"preciseIdentifier":"s:Si","kind":"typeIdentifier","text":"Int"},{"kind":"text","text":")"}],"url":"\/documentation\/discogsservice\/components\/schemas\/master\/value2payload\/codingkeys\/init(intvalue:)","title":"init(intValue:)"}}} |