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
9.4 KiB
JSON
1 line
9.4 KiB
JSON
{"sections":[],"hierarchy":{"paths":[["doc:\/\/DiscogsService\/documentation\/DiscogsService","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetReleaseRating","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetReleaseRating\/Output","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetReleaseRating\/Output\/Ok-swift.struct"]]},"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetReleaseRating\/Output\/Ok-swift.struct\/Body-swift.enum"},"variants":[{"paths":["\/documentation\/discogsservice\/operations\/getreleaserating\/output\/ok-swift.struct\/body-swift.enum"],"traits":[{"interfaceLanguage":"swift"}]}],"schemaVersion":{"major":0,"minor":3,"patch":0},"metadata":{"title":"Operations.GetReleaseRating.Output.Ok.Body","roleHeading":"Enumeration","fragments":[{"text":"enum","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"Body"}],"externalID":"s:14DiscogsService10OperationsO16GetReleaseRatingO6OutputO2OkV4BodyO","role":"symbol","symbolKind":"enum","navigatorTitle":[{"text":"Body","kind":"identifier"}],"modules":[{"name":"DiscogsService"}]},"topicSections":[{"title":"Enumeration Cases","anchor":"Enumeration-Cases","identifiers":["doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetReleaseRating\/Output\/Ok-swift.struct\/Body-swift.enum\/json(_:)"],"generated":true},{"title":"Instance Properties","anchor":"Instance-Properties","identifiers":["doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetReleaseRating\/Output\/Ok-swift.struct\/Body-swift.enum\/json"],"generated":true},{"generated":true,"anchor":"Default-Implementations","title":"Default Implementations","identifiers":["doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetReleaseRating\/Output\/Ok-swift.struct\/Body-swift.enum\/Equatable-Implementations"]}],"relationshipsSections":[{"identifiers":["doc:\/\/DiscogsService\/SQ","doc:\/\/DiscogsService\/SH","doc:\/\/DiscogsService\/s8SendableP","doc:\/\/DiscogsService\/s16SendableMetatypeP"],"title":"Conforms To","type":"conformsTo","kind":"relationships"}],"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"kind":"attribute","text":"@frozen"},{"kind":"text","text":" "},{"text":"enum","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Body","kind":"identifier"}],"platforms":["macOS"],"languages":["swift"]}]},{"kind":"content","content":[{"level":2,"text":"Overview","anchor":"overview","type":"heading"},{"name":"Remark","style":"note","type":"aside","content":[{"inlineContent":[{"text":"Generated from ","type":"text"},{"type":"codeVoice","code":"#\/paths\/releases\/{release_id}\/rating\/GET\/responses\/200\/content"},{"text":".","type":"text"}],"type":"paragraph"}]}]}],"kind":"symbol","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/Operations/GetReleaseRating":{"kind":"symbol","role":"symbol","type":"topic","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetReleaseRating","abstract":[{"text":"Get information about a rating of release.","type":"text"}],"fragments":[{"text":"enum","kind":"keyword"},{"text":" ","kind":"text"},{"text":"GetReleaseRating","kind":"identifier"}],"url":"\/documentation\/discogsservice\/operations\/getreleaserating","title":"Operations.GetReleaseRating","navigatorTitle":[{"kind":"identifier","text":"GetReleaseRating"}]},"doc://DiscogsService/documentation/DiscogsService/Operations/GetReleaseRating/Output/Ok-swift.struct/Body-swift.enum/json":{"title":"json","url":"\/documentation\/discogsservice\/operations\/getreleaserating\/output\/ok-swift.struct\/body-swift.enum\/json","role":"symbol","abstract":[{"text":"The associated value of the enum case if ","type":"text"},{"code":"self","type":"codeVoice"},{"text":" is ","type":"text"},{"code":".json","type":"codeVoice"},{"text":".","type":"text"}],"type":"topic","fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"json","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:14DiscogsService10ComponentsO7SchemasO13ReleaseRatingV","text":"ReleaseRating","kind":"typeIdentifier"}],"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetReleaseRating\/Output\/Ok-swift.struct\/Body-swift.enum\/json","kind":"symbol"},"doc://DiscogsService/documentation/DiscogsService/Operations/GetReleaseRating/Output/Ok-swift.struct/Body-swift.enum/Equatable-Implementations":{"role":"collectionGroup","abstract":[],"kind":"article","type":"topic","url":"\/documentation\/discogsservice\/operations\/getreleaserating\/output\/ok-swift.struct\/body-swift.enum\/equatable-implementations","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetReleaseRating\/Output\/Ok-swift.struct\/Body-swift.enum\/Equatable-Implementations","title":"Equatable Implementations"},"doc://DiscogsService/documentation/DiscogsService/Operations/GetReleaseRating/Output/Ok-swift.struct/Body-swift.enum":{"url":"\/documentation\/discogsservice\/operations\/getreleaserating\/output\/ok-swift.struct\/body-swift.enum","abstract":[],"kind":"symbol","type":"topic","navigatorTitle":[{"text":"Body","kind":"identifier"}],"role":"symbol","fragments":[{"text":"enum","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Body","kind":"identifier"}],"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetReleaseRating\/Output\/Ok-swift.struct\/Body-swift.enum","title":"Operations.GetReleaseRating.Output.Ok.Body"},"doc://DiscogsService/s16SendableMetatypeP":{"type":"unresolvable","title":"Swift.SendableMetatype","identifier":"doc:\/\/DiscogsService\/s16SendableMetatypeP"},"doc://DiscogsService/SQ":{"type":"unresolvable","title":"Swift.Equatable","identifier":"doc:\/\/DiscogsService\/SQ"},"doc://DiscogsService/documentation/DiscogsService/Operations/GetReleaseRating/Output/Ok-swift.struct":{"url":"\/documentation\/discogsservice\/operations\/getreleaserating\/output\/ok-swift.struct","abstract":[],"kind":"symbol","type":"topic","navigatorTitle":[{"text":"Ok","kind":"identifier"}],"role":"symbol","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Ok","kind":"identifier"}],"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetReleaseRating\/Output\/Ok-swift.struct","title":"Operations.GetReleaseRating.Output.Ok"},"doc://DiscogsService/documentation/DiscogsService/Operations/GetReleaseRating/Output":{"kind":"symbol","role":"symbol","type":"topic","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetReleaseRating\/Output","abstract":[],"fragments":[{"text":"enum","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Output","kind":"identifier"}],"title":"Operations.GetReleaseRating.Output","url":"\/documentation\/discogsservice\/operations\/getreleaserating\/output","navigatorTitle":[{"text":"Output","kind":"identifier"}]},"doc://DiscogsService/SH":{"type":"unresolvable","identifier":"doc:\/\/DiscogsService\/SH","title":"Swift.Hashable"},"doc://DiscogsService/documentation/DiscogsService/Operations/GetReleaseRating/Output/Ok-swift.struct/Body-swift.enum/json(_:)":{"role":"symbol","abstract":[],"url":"\/documentation\/discogsservice\/operations\/getreleaserating\/output\/ok-swift.struct\/body-swift.enum\/json(_:)","kind":"symbol","type":"topic","fragments":[{"text":"case","kind":"keyword"},{"text":" ","kind":"text"},{"text":"json","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:14DiscogsService10ComponentsO7SchemasO13ReleaseRatingV","text":"ReleaseRating","kind":"typeIdentifier"},{"text":")","kind":"text"}],"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetReleaseRating\/Output\/Ok-swift.struct\/Body-swift.enum\/json(_:)","title":"Operations.GetReleaseRating.Output.Ok.Body.json(_:)"},"doc://DiscogsService/documentation/DiscogsService/Operations":{"kind":"symbol","abstract":[{"type":"text","text":"API operations, with input and output types, generated from "},{"code":"#\/paths","type":"codeVoice"},{"type":"text","text":" in the OpenAPI document."}],"fragments":[{"kind":"keyword","text":"enum"},{"kind":"text","text":" "},{"kind":"identifier","text":"Operations"}],"type":"topic","url":"\/documentation\/discogsservice\/operations","role":"symbol","navigatorTitle":[{"kind":"identifier","text":"Operations"}],"title":"Operations","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations"},"doc://DiscogsService/s8SendableP":{"type":"unresolvable","title":"Swift.Sendable","identifier":"doc:\/\/DiscogsService\/s8SendableP"}}} |