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