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
{"primaryContentSections":[{"declarations":[{"tokens":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"ReleaseResult","kind":"identifier"}],"platforms":["macOS"],"languages":["swift"]}],"kind":"declarations"},{"content":[{"text":"Overview","level":2,"type":"heading","anchor":"overview"},{"content":[{"type":"paragraph","inlineContent":[{"text":"Generated from ","type":"text"},{"code":"#\/components\/schemas\/ReleaseResult","type":"codeVoice"},{"text":".","type":"text"}]}],"style":"note","type":"aside","name":"Remark"}],"kind":"content"}],"sections":[],"kind":"symbol","schemaVersion":{"minor":3,"patch":0,"major":0},"topicSections":[{"identifiers":["doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/ReleaseResult\/Value2Payload"],"title":"Structures","anchor":"Structures","generated":true},{"identifiers":["doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/ReleaseResult\/init(from:)","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/ReleaseResult\/init(value1:value2:)"],"title":"Initializers","anchor":"Initializers","generated":true},{"identifiers":["doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/ReleaseResult\/value1","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/ReleaseResult\/value2"],"title":"Instance Properties","anchor":"Instance-Properties","generated":true},{"identifiers":["doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/ReleaseResult\/encode(to:)"],"title":"Instance Methods","anchor":"Instance-Methods","generated":true},{"identifiers":["doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/ReleaseResult\/Equatable-Implementations"],"title":"Default Implementations","anchor":"Default-Implementations","generated":true}],"identifier":{"url":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/ReleaseResult","interfaceLanguage":"swift"},"metadata":{"navigatorTitle":[{"text":"ReleaseResult","kind":"identifier"}],"role":"symbol","modules":[{"name":"DiscogsService"}],"externalID":"s:14DiscogsService10ComponentsO7SchemasO13ReleaseResultV","title":"Components.Schemas.ReleaseResult","symbolKind":"struct","roleHeading":"Structure","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"ReleaseResult","kind":"identifier"}]},"abstract":[{"text":"A type that represents a release search result.","type":"text"}],"hierarchy":{"paths":[["doc:\/\/DiscogsService\/documentation\/DiscogsService","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas"]]},"relationshipsSections":[{"identifiers":["doc:\/\/DiscogsService\/Se","doc:\/\/DiscogsService\/SE","doc:\/\/DiscogsService\/SQ","doc:\/\/DiscogsService\/SH","doc:\/\/DiscogsService\/s8SendableP","doc:\/\/DiscogsService\/s16SendableMetatypeP"],"title":"Conforms To","type":"conformsTo","kind":"relationships"}],"variants":[{"paths":["\/documentation\/discogsservice\/components\/schemas\/releaseresult"],"traits":[{"interfaceLanguage":"swift"}]}],"references":{"doc://DiscogsService/documentation/DiscogsService/Components/Schemas/ReleaseResult/encode(to:)":{"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/ReleaseResult\/encode(to:)","role":"symbol","abstract":[],"fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"encode"},{"kind":"text","text":"("},{"kind":"externalParam","text":"to"},{"kind":"text","text":": any "},{"kind":"typeIdentifier","preciseIdentifier":"s:s7EncoderP","text":"Encoder"},{"kind":"text","text":") "},{"kind":"keyword","text":"throws"}],"url":"\/documentation\/discogsservice\/components\/schemas\/releaseresult\/encode(to:)","title":"encode(to:)","kind":"symbol","type":"topic"},"doc://DiscogsService/s16SendableMetatypeP":{"type":"unresolvable","title":"Swift.SendableMetatype","identifier":"doc:\/\/DiscogsService\/s16SendableMetatypeP"},"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/Components/Schemas/ReleaseResult/init(value1:value2:)":{"kind":"symbol","role":"symbol","type":"topic","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/ReleaseResult\/init(value1:value2:)","abstract":[{"text":"Creates a new ","type":"text"},{"code":"ReleaseResult","type":"codeVoice"},{"text":".","type":"text"}],"fragments":[{"text":"init","kind":"identifier"},{"text":"(","kind":"text"},{"text":"value1","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:14DiscogsService10ComponentsO","text":"Components","kind":"typeIdentifier"},{"text":".","kind":"text"},{"preciseIdentifier":"s:14DiscogsService10ComponentsO7SchemasO","text":"Schemas","kind":"typeIdentifier"},{"text":".","kind":"text"},{"preciseIdentifier":"s:14DiscogsService10ComponentsO7SchemasO12SearchResultV","text":"SearchResult","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"value2","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:14DiscogsService10ComponentsO","text":"Components","kind":"typeIdentifier"},{"text":".","kind":"text"},{"preciseIdentifier":"s:14DiscogsService10ComponentsO7SchemasO","text":"Schemas","kind":"typeIdentifier"},{"text":".","kind":"text"},{"preciseIdentifier":"s:14DiscogsService10ComponentsO7SchemasO13ReleaseResultV","text":"ReleaseResult","kind":"typeIdentifier"},{"text":".","kind":"text"},{"preciseIdentifier":"s:14DiscogsService10ComponentsO7SchemasO13ReleaseResultV13Value2PayloadV","text":"Value2Payload","kind":"typeIdentifier"},{"text":")","kind":"text"}],"title":"init(value1:value2:)","url":"\/documentation\/discogsservice\/components\/schemas\/releaseresult\/init(value1:value2:)"},"doc://DiscogsService/documentation/DiscogsService/Components/Schemas/ReleaseResult/value2":{"kind":"symbol","role":"symbol","type":"topic","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/ReleaseResult\/value2","abstract":[],"fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"value2","kind":"identifier"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:14DiscogsService10ComponentsO","text":"Components","kind":"typeIdentifier"},{"text":".","kind":"text"},{"preciseIdentifier":"s:14DiscogsService10ComponentsO7SchemasO","text":"Schemas","kind":"typeIdentifier"},{"text":".","kind":"text"},{"preciseIdentifier":"s:14DiscogsService10ComponentsO7SchemasO13ReleaseResultV","text":"ReleaseResult","kind":"typeIdentifier"},{"text":".","kind":"text"},{"preciseIdentifier":"s:14DiscogsService10ComponentsO7SchemasO13ReleaseResultV13Value2PayloadV","text":"Value2Payload","kind":"typeIdentifier"}],"title":"value2","url":"\/documentation\/discogsservice\/components\/schemas\/releaseresult\/value2"},"doc://DiscogsService/SQ":{"type":"unresolvable","title":"Swift.Equatable","identifier":"doc:\/\/DiscogsService\/SQ"},"doc://DiscogsService/documentation/DiscogsService/Components/Schemas/ReleaseResult/Value2Payload":{"navigatorTitle":[{"text":"Value2Payload","kind":"identifier"}],"abstract":[],"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/ReleaseResult\/Value2Payload","role":"symbol","kind":"symbol","type":"topic","url":"\/documentation\/discogsservice\/components\/schemas\/releaseresult\/value2payload","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"Value2Payload"}],"title":"Components.Schemas.ReleaseResult.Value2Payload"},"doc://DiscogsService/documentation/DiscogsService/Components/Schemas/ReleaseResult/Equatable-Implementations":{"kind":"article","role":"collectionGroup","type":"topic","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/ReleaseResult\/Equatable-Implementations","abstract":[],"title":"Equatable Implementations","url":"\/documentation\/discogsservice\/components\/schemas\/releaseresult\/equatable-implementations"},"doc://DiscogsService/SH":{"type":"unresolvable","title":"Swift.Hashable","identifier":"doc:\/\/DiscogsService\/SH"},"doc://DiscogsService/documentation/DiscogsService/Components/Schemas/ReleaseResult/value1":{"title":"value1","fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"value1","kind":"identifier"},{"text":": ","kind":"text"},{"text":"Components","preciseIdentifier":"s:14DiscogsService10ComponentsO","kind":"typeIdentifier"},{"text":".","kind":"text"},{"text":"Schemas","preciseIdentifier":"s:14DiscogsService10ComponentsO7SchemasO","kind":"typeIdentifier"},{"text":".","kind":"text"},{"text":"SearchResult","preciseIdentifier":"s:14DiscogsService10ComponentsO7SchemasO12SearchResultV","kind":"typeIdentifier"}],"url":"\/documentation\/discogsservice\/components\/schemas\/releaseresult\/value1","type":"topic","role":"symbol","abstract":[],"kind":"symbol","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/ReleaseResult\/value1"},"doc://DiscogsService/Se":{"type":"unresolvable","title":"Swift.Decodable","identifier":"doc:\/\/DiscogsService\/Se"},"doc://DiscogsService/s8SendableP":{"type":"unresolvable","title":"Swift.Sendable","identifier":"doc:\/\/DiscogsService\/s8SendableP"},"doc://DiscogsService/documentation/DiscogsService/Components/Schemas/ReleaseResult/init(from:)":{"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/ReleaseResult\/init(from:)","url":"\/documentation\/discogsservice\/components\/schemas\/releaseresult\/init(from:)","kind":"symbol","fragments":[{"text":"init","kind":"identifier"},{"text":"(","kind":"text"},{"text":"from","kind":"externalParam"},{"text":": any ","kind":"text"},{"text":"Decoder","kind":"typeIdentifier","preciseIdentifier":"s:s7DecoderP"},{"text":") ","kind":"text"},{"text":"throws","kind":"keyword"}],"abstract":[],"title":"init(from:)","role":"symbol","type":"topic"},"doc://DiscogsService/SE":{"type":"unresolvable","title":"Swift.Encodable","identifier":"doc:\/\/DiscogsService\/SE"},"doc://DiscogsService/documentation/DiscogsService/Components/Schemas/ReleaseResult":{"url":"\/documentation\/discogsservice\/components\/schemas\/releaseresult","type":"topic","role":"symbol","abstract":[{"text":"A type that represents a release search result.","type":"text"}],"title":"Components.Schemas.ReleaseResult","kind":"symbol","fragments":[{"text":"struct","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"ReleaseResult"}],"navigatorTitle":[{"kind":"identifier","text":"ReleaseResult"}],"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/ReleaseResult"},"doc://DiscogsService/documentation/DiscogsService":{"title":"DiscogsService","url":"\/documentation\/discogsservice","type":"topic","role":"collection","abstract":[],"kind":"symbol","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService"}}} |