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