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
21 KiB
JSON
1 line
21 KiB
JSON
{"schemaVersion":{"minor":3,"patch":0,"major":0},"sections":[],"abstract":[{"text":"A type that represents a version of a release.","type":"text"}],"relationshipsSections":[{"identifiers":["doc:\/\/DiscogsService\/Se","doc:\/\/DiscogsService\/SE","doc:\/\/DiscogsService\/SQ","doc:\/\/DiscogsService\/SH","doc:\/\/DiscogsService\/s8SendableP","doc:\/\/DiscogsService\/s16SendableMetatypeP"],"type":"conformsTo","kind":"relationships","title":"Conforms To"}],"identifier":{"url":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/ReleaseVersion","interfaceLanguage":"swift"},"kind":"symbol","primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"ReleaseVersion","kind":"identifier"}],"platforms":["macOS"],"languages":["swift"]}]},{"content":[{"anchor":"overview","level":2,"type":"heading","text":"Overview"},{"name":"Remark","style":"note","content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"Generated from "},{"type":"codeVoice","code":"#\/components\/schemas\/ReleaseVersion"},{"type":"text","text":"."}]}],"type":"aside"}],"kind":"content"}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/discogsservice\/components\/schemas\/releaseversion"]}],"hierarchy":{"paths":[["doc:\/\/DiscogsService\/documentation\/DiscogsService","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas"]]},"metadata":{"modules":[{"name":"DiscogsService"}],"title":"Components.Schemas.ReleaseVersion","externalID":"s:14DiscogsService10ComponentsO7SchemasO14ReleaseVersionV","role":"symbol","symbolKind":"struct","navigatorTitle":[{"kind":"identifier","text":"ReleaseVersion"}],"fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"ReleaseVersion","kind":"identifier"}],"roleHeading":"Structure"},"topicSections":[{"identifiers":["doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/ReleaseVersion\/StatsPayload"],"anchor":"Structures","title":"Structures","generated":true},{"identifiers":["doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/ReleaseVersion\/init(from:)","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/ReleaseVersion\/init(id:resourceUrl:status:thumb:format:country:title:label:released:majorFormats:catno:stats:)"],"anchor":"Initializers","title":"Initializers","generated":true},{"identifiers":["doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/ReleaseVersion\/catno","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/ReleaseVersion\/country","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/ReleaseVersion\/format","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/ReleaseVersion\/id","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/ReleaseVersion\/label","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/ReleaseVersion\/majorFormats","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/ReleaseVersion\/released","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/ReleaseVersion\/resourceUrl","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/ReleaseVersion\/stats","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/ReleaseVersion\/status","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/ReleaseVersion\/thumb","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/ReleaseVersion\/title"],"anchor":"Instance-Properties","title":"Instance Properties","generated":true},{"identifiers":["doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/ReleaseVersion\/CodingKeys"],"anchor":"Enumerations","title":"Enumerations","generated":true},{"identifiers":["doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/ReleaseVersion\/Equatable-Implementations"],"anchor":"Default-Implementations","title":"Default Implementations","generated":true}],"references":{"doc://DiscogsService/documentation/DiscogsService/Components/Schemas/ReleaseVersion/init(id:resourceUrl:status:thumb:format:country:title:label:released:majorFormats:catno:stats:)":{"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/ReleaseVersion\/init(id:resourceUrl:status:thumb:format:country:title:label:released:majorFormats:catno:stats:)","role":"symbol","abstract":[{"type":"text","text":"Creates a new "},{"code":"ReleaseVersion","type":"codeVoice"},{"type":"text","text":"."}],"fragments":[{"text":"init","kind":"identifier"},{"text":"(","kind":"text"},{"text":"id","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"Int","preciseIdentifier":"s:Si","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"resourceUrl","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":", ","kind":"text"},{"text":"status","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":", ","kind":"text"},{"text":"thumb","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"format","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":", ","kind":"text"},{"text":"country","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":"?, ","kind":"text"},{"text":"title","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"label","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":", ","kind":"text"},{"text":"released","kind":"externalParam"},{"kind":"text","text":": "},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"majorFormats","kind":"externalParam"},{"text":": [","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":"], ","kind":"text"},{"text":"catno","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":"?, ","kind":"text"},{"text":"stats","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"Components","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10ComponentsO"},{"text":".","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10ComponentsO7SchemasO","text":"Schemas"},{"text":".","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10ComponentsO7SchemasO14ReleaseVersionV","text":"ReleaseVersion"},{"text":".","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10ComponentsO7SchemasO14ReleaseVersionV12StatsPayloadV","text":"StatsPayload"},{"text":")","kind":"text"}],"title":"init(id:resourceUrl:status:thumb:format:country:title:label:released:majorFormats:catno:stats:)","url":"\/documentation\/discogsservice\/components\/schemas\/releaseversion\/init(id:resourceurl:status:thumb:format:country:title:label:released:majorformats:catno:stats:)","type":"topic","kind":"symbol"},"doc://DiscogsService/s8SendableP":{"type":"unresolvable","identifier":"doc:\/\/DiscogsService\/s8SendableP","title":"Swift.Sendable"},"doc://DiscogsService/documentation/DiscogsService/Components/Schemas/ReleaseVersion/StatsPayload":{"url":"\/documentation\/discogsservice\/components\/schemas\/releaseversion\/statspayload","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/ReleaseVersion\/StatsPayload","role":"symbol","navigatorTitle":[{"kind":"identifier","text":"StatsPayload"}],"kind":"symbol","title":"Components.Schemas.ReleaseVersion.StatsPayload","abstract":[{"text":"A type contains statictics about a release version.","type":"text"}],"fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"StatsPayload"}],"type":"topic"},"doc://DiscogsService/documentation/DiscogsService/Components/Schemas/ReleaseVersion/Equatable-Implementations":{"type":"topic","title":"Equatable Implementations","abstract":[],"url":"\/documentation\/discogsservice\/components\/schemas\/releaseversion\/equatable-implementations","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/ReleaseVersion\/Equatable-Implementations","kind":"article","role":"collectionGroup"},"doc://DiscogsService/documentation/DiscogsService/Components/Schemas/ReleaseVersion/init(from:)":{"title":"init(from:)","url":"\/documentation\/discogsservice\/components\/schemas\/releaseversion\/init(from:)","abstract":[],"type":"topic","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/ReleaseVersion\/init(from:)","kind":"symbol","role":"symbol","fragments":[{"kind":"identifier","text":"init"},{"kind":"text","text":"("},{"kind":"externalParam","text":"from"},{"kind":"text","text":": any "},{"kind":"typeIdentifier","preciseIdentifier":"s:s7DecoderP","text":"Decoder"},{"kind":"text","text":") "},{"kind":"keyword","text":"throws"}]},"doc://DiscogsService/documentation/DiscogsService/Components/Schemas/ReleaseVersion/resourceUrl":{"url":"\/documentation\/discogsservice\/components\/schemas\/releaseversion\/resourceurl","abstract":[{"type":"text","text":"A URI resource of a release version."}],"kind":"symbol","type":"topic","role":"symbol","fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"resourceUrl"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"}],"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/ReleaseVersion\/resourceUrl","title":"resourceUrl"},"doc://DiscogsService/documentation/DiscogsService/Components/Schemas/ReleaseVersion/catno":{"kind":"symbol","role":"symbol","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/ReleaseVersion\/catno","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"catno"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":"?"}],"url":"\/documentation\/discogsservice\/components\/schemas\/releaseversion\/catno","type":"topic","title":"catno","abstract":[{"type":"text","text":"A category number of a release version, if any."}]},"doc://DiscogsService/documentation/DiscogsService/Components/Schemas/ReleaseVersion/CodingKeys":{"navigatorTitle":[{"kind":"identifier","text":"CodingKeys"}],"kind":"symbol","fragments":[{"text":"enum","kind":"keyword"},{"text":" ","kind":"text"},{"text":"CodingKeys","kind":"identifier"}],"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/ReleaseVersion\/CodingKeys","url":"\/documentation\/discogsservice\/components\/schemas\/releaseversion\/codingkeys","role":"symbol","type":"topic","abstract":[],"title":"Components.Schemas.ReleaseVersion.CodingKeys"},"doc://DiscogsService/documentation/DiscogsService/Components/Schemas/ReleaseVersion/title":{"type":"topic","url":"\/documentation\/discogsservice\/components\/schemas\/releaseversion\/title","abstract":[{"text":"A title of a release version.","type":"text"}],"title":"title","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/ReleaseVersion\/title","kind":"symbol","role":"symbol","fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"title","kind":"identifier"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"}]},"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/ReleaseVersion/thumb":{"kind":"symbol","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"thumb"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"}],"url":"\/documentation\/discogsservice\/components\/schemas\/releaseversion\/thumb","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/ReleaseVersion\/thumb","role":"symbol","abstract":[{"type":"text","text":"A URL link to a thumbnail of a release version."}],"type":"topic","title":"thumb"},"doc://DiscogsService/documentation/DiscogsService/Components/Schemas/ReleaseVersion/country":{"url":"\/documentation\/discogsservice\/components\/schemas\/releaseversion\/country","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/ReleaseVersion\/country","role":"symbol","kind":"symbol","title":"country","abstract":[{"type":"text","text":"A country of a release version, if any."}],"fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"country","kind":"identifier"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":"?","kind":"text"}],"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/ReleaseVersion/stats":{"role":"symbol","abstract":[{"type":"text","text":"A type contains statictics about a release version."}],"kind":"symbol","type":"topic","url":"\/documentation\/discogsservice\/components\/schemas\/releaseversion\/stats","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"stats"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10ComponentsO","text":"Components"},{"text":".","kind":"text"},{"text":"Schemas","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10ComponentsO7SchemasO"},{"text":".","kind":"text"},{"text":"ReleaseVersion","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10ComponentsO7SchemasO14ReleaseVersionV"},{"text":".","kind":"text"},{"text":"StatsPayload","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10ComponentsO7SchemasO14ReleaseVersionV12StatsPayloadV"}],"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/ReleaseVersion\/stats","title":"stats"},"doc://DiscogsService/s16SendableMetatypeP":{"type":"unresolvable","identifier":"doc:\/\/DiscogsService\/s16SendableMetatypeP","title":"Swift.SendableMetatype"},"doc://DiscogsService/documentation/DiscogsService/Components/Schemas/ReleaseVersion/majorFormats":{"title":"majorFormats","url":"\/documentation\/discogsservice\/components\/schemas\/releaseversion\/majorformats","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/ReleaseVersion\/majorFormats","fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"majorFormats","kind":"identifier"},{"text":": [","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":"]","kind":"text"}],"abstract":[{"text":"A list of formats of a release version.","type":"text"}],"kind":"symbol","role":"symbol","type":"topic"},"doc://DiscogsService/documentation/DiscogsService/Components/Schemas/ReleaseVersion/released":{"type":"topic","title":"released","url":"\/documentation\/discogsservice\/components\/schemas\/releaseversion\/released","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/ReleaseVersion\/released","abstract":[{"type":"text","text":"A release year of a release version."}],"kind":"symbol","role":"symbol","fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"released","kind":"identifier"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"}]},"doc://DiscogsService/documentation/DiscogsService/Components/Schemas/ReleaseVersion/format":{"url":"\/documentation\/discogsservice\/components\/schemas\/releaseversion\/format","type":"topic","role":"symbol","abstract":[{"type":"text","text":"A format of a release version."}],"title":"format","kind":"symbol","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"format"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"}],"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/ReleaseVersion\/format"},"doc://DiscogsService/documentation/DiscogsService/Components/Schemas/ReleaseVersion/id":{"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/ReleaseVersion\/id","kind":"symbol","fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"id","kind":"identifier"},{"text":": ","kind":"text"},{"text":"Int","kind":"typeIdentifier","preciseIdentifier":"s:Si"}],"type":"topic","url":"\/documentation\/discogsservice\/components\/schemas\/releaseversion\/id","role":"symbol","title":"id","abstract":[{"text":"An identifier of a release version.","type":"text"}]},"doc://DiscogsService/documentation/DiscogsService/Components/Schemas/ReleaseVersion":{"url":"\/documentation\/discogsservice\/components\/schemas\/releaseversion","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/ReleaseVersion","role":"symbol","navigatorTitle":[{"kind":"identifier","text":"ReleaseVersion"}],"kind":"symbol","title":"Components.Schemas.ReleaseVersion","abstract":[{"text":"A type that represents a version of a release.","type":"text"}],"fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"ReleaseVersion"}],"type":"topic"},"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/Se":{"type":"unresolvable","identifier":"doc:\/\/DiscogsService\/Se","title":"Swift.Decodable"},"doc://DiscogsService/documentation/DiscogsService/Components/Schemas/ReleaseVersion/status":{"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/ReleaseVersion\/status","url":"\/documentation\/discogsservice\/components\/schemas\/releaseversion\/status","kind":"symbol","fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"status","kind":"identifier"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"}],"abstract":[{"text":"A status of a release version.","type":"text"}],"title":"status","role":"symbol","type":"topic"},"doc://DiscogsService/SE":{"type":"unresolvable","identifier":"doc:\/\/DiscogsService\/SE","title":"Swift.Encodable"},"doc://DiscogsService/documentation/DiscogsService/Components/Schemas/ReleaseVersion/label":{"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/ReleaseVersion\/label","url":"\/documentation\/discogsservice\/components\/schemas\/releaseversion\/label","kind":"symbol","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"label"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"}],"title":"label","abstract":[{"type":"text","text":"A label of a release version."}],"role":"symbol","type":"topic"},"doc://DiscogsService/SQ":{"type":"unresolvable","identifier":"doc:\/\/DiscogsService\/SQ","title":"Swift.Equatable"},"doc://DiscogsService/SH":{"type":"unresolvable","identifier":"doc:\/\/DiscogsService\/SH","title":"Swift.Hashable"}}} |