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
{"hierarchy":{"paths":[["doc:\/\/DiscogsService\/documentation\/DiscogsService","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetLabel","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetLabel\/Output"]]},"topicSections":[{"anchor":"Structures","title":"Structures","generated":true,"identifiers":["doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetLabel\/Output\/Ok-swift.struct\/Headers-swift.struct"]},{"anchor":"Initializers","title":"Initializers","generated":true,"identifiers":["doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetLabel\/Output\/Ok-swift.struct\/init(headers:body:)"]},{"anchor":"Instance-Properties","title":"Instance Properties","generated":true,"identifiers":["doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetLabel\/Output\/Ok-swift.struct\/body-swift.property","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetLabel\/Output\/Ok-swift.struct\/headers-swift.property"]},{"anchor":"Enumerations","title":"Enumerations","generated":true,"identifiers":["doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetLabel\/Output\/Ok-swift.struct\/Body-swift.enum"]},{"anchor":"Default-Implementations","title":"Default Implementations","generated":true,"identifiers":["doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetLabel\/Output\/Ok-swift.struct\/Equatable-Implementations"]}],"schemaVersion":{"minor":3,"patch":0,"major":0},"relationshipsSections":[{"title":"Conforms To","identifiers":["doc:\/\/DiscogsService\/SQ","doc:\/\/DiscogsService\/SH","doc:\/\/DiscogsService\/s8SendableP","doc:\/\/DiscogsService\/s16SendableMetatypeP"],"type":"conformsTo","kind":"relationships"}],"primaryContentSections":[{"declarations":[{"languages":["swift"],"tokens":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"Ok"}],"platforms":["macOS"]}],"kind":"declarations"}],"metadata":{"roleHeading":"Structure","title":"Operations.GetLabel.Output.Ok","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"Ok"}],"externalID":"s:14DiscogsService10OperationsO8GetLabelO6OutputO2OkV","role":"symbol","symbolKind":"struct","navigatorTitle":[{"text":"Ok","kind":"identifier"}],"modules":[{"name":"DiscogsService"}]},"kind":"symbol","sections":[],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetLabel\/Output\/Ok-swift.struct"},"variants":[{"paths":["\/documentation\/discogsservice\/operations\/getlabel\/output\/ok-swift.struct"],"traits":[{"interfaceLanguage":"swift"}]}],"references":{"doc://DiscogsService/documentation/DiscogsService/Operations/GetLabel/Output":{"title":"Operations.GetLabel.Output","fragments":[{"text":"enum","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Output","kind":"identifier"}],"type":"topic","url":"\/documentation\/discogsservice\/operations\/getlabel\/output","role":"symbol","navigatorTitle":[{"text":"Output","kind":"identifier"}],"abstract":[],"kind":"symbol","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetLabel\/Output"},"doc://DiscogsService/documentation/DiscogsService/Operations/GetLabel":{"kind":"symbol","role":"symbol","navigatorTitle":[{"kind":"identifier","text":"GetLabel"}],"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetLabel","fragments":[{"kind":"keyword","text":"enum"},{"kind":"text","text":" "},{"kind":"identifier","text":"GetLabel"}],"url":"\/documentation\/discogsservice\/operations\/getlabel","type":"topic","title":"Operations.GetLabel","abstract":[{"text":"Get information about a label","type":"text"}]},"doc://DiscogsService/documentation/DiscogsService/Operations/GetLabel/Output/Ok-swift.struct/Headers-swift.struct":{"title":"Operations.GetLabel.Output.Ok.Headers","url":"\/documentation\/discogsservice\/operations\/getlabel\/output\/ok-swift.struct\/headers-swift.struct","abstract":[],"type":"topic","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetLabel\/Output\/Ok-swift.struct\/Headers-swift.struct","kind":"symbol","role":"symbol","fragments":[{"text":"struct","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"Headers"}],"navigatorTitle":[{"kind":"identifier","text":"Headers"}]},"doc://DiscogsService/documentation/DiscogsService/Operations/GetLabel/Output/Ok-swift.struct":{"title":"Operations.GetLabel.Output.Ok","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Ok","kind":"identifier"}],"type":"topic","url":"\/documentation\/discogsservice\/operations\/getlabel\/output\/ok-swift.struct","role":"symbol","navigatorTitle":[{"text":"Ok","kind":"identifier"}],"abstract":[],"kind":"symbol","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetLabel\/Output\/Ok-swift.struct"},"doc://DiscogsService/SQ":{"identifier":"doc:\/\/DiscogsService\/SQ","title":"Swift.Equatable","type":"unresolvable"},"doc://DiscogsService/s16SendableMetatypeP":{"identifier":"doc:\/\/DiscogsService\/s16SendableMetatypeP","title":"Swift.SendableMetatype","type":"unresolvable"},"doc://DiscogsService/documentation/DiscogsService":{"title":"DiscogsService","url":"\/documentation\/discogsservice","type":"topic","role":"collection","abstract":[],"kind":"symbol","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService"},"doc://DiscogsService/SH":{"identifier":"doc:\/\/DiscogsService\/SH","title":"Swift.Hashable","type":"unresolvable"},"doc://DiscogsService/documentation/DiscogsService/Operations/GetLabel/Output/Ok-swift.struct/headers-swift.property":{"url":"\/documentation\/discogsservice\/operations\/getlabel\/output\/ok-swift.struct\/headers-swift.property","abstract":[{"type":"text","text":"Received HTTP response headers"}],"kind":"symbol","type":"topic","role":"symbol","fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"headers","kind":"identifier"},{"text":": ","kind":"text"},{"text":"Operations","preciseIdentifier":"s:14DiscogsService10OperationsO","kind":"typeIdentifier"},{"text":".","kind":"text"},{"text":"GetLabel","preciseIdentifier":"s:14DiscogsService10OperationsO8GetLabelO","kind":"typeIdentifier"},{"text":".","kind":"text"},{"text":"Output","preciseIdentifier":"s:14DiscogsService10OperationsO8GetLabelO6OutputO","kind":"typeIdentifier"},{"text":".","kind":"text"},{"text":"Ok","preciseIdentifier":"s:14DiscogsService10OperationsO8GetLabelO6OutputO2OkV","kind":"typeIdentifier"},{"text":".","kind":"text"},{"text":"Headers","preciseIdentifier":"s:14DiscogsService10OperationsO8GetLabelO6OutputO2OkV7HeadersV","kind":"typeIdentifier"}],"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetLabel\/Output\/Ok-swift.struct\/headers-swift.property","title":"headers"},"doc://DiscogsService/documentation/DiscogsService/Operations/GetLabel/Output/Ok-swift.struct/Body-swift.enum":{"url":"\/documentation\/discogsservice\/operations\/getlabel\/output\/ok-swift.struct\/body-swift.enum","title":"Operations.GetLabel.Output.Ok.Body","role":"symbol","abstract":[],"type":"topic","fragments":[{"kind":"keyword","text":"enum"},{"kind":"text","text":" "},{"kind":"identifier","text":"Body"}],"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetLabel\/Output\/Ok-swift.struct\/Body-swift.enum","navigatorTitle":[{"kind":"identifier","text":"Body"}],"kind":"symbol"},"doc://DiscogsService/s8SendableP":{"identifier":"doc:\/\/DiscogsService\/s8SendableP","title":"Swift.Sendable","type":"unresolvable"},"doc://DiscogsService/documentation/DiscogsService/Operations/GetLabel/Output/Ok-swift.struct/init(headers:body:)":{"url":"\/documentation\/discogsservice\/operations\/getlabel\/output\/ok-swift.struct\/init(headers:body:)","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetLabel\/Output\/Ok-swift.struct\/init(headers:body:)","role":"symbol","kind":"symbol","title":"init(headers:body:)","abstract":[{"type":"text","text":"Creates a new "},{"type":"codeVoice","code":"Ok"},{"type":"text","text":"."}],"fragments":[{"kind":"identifier","text":"init"},{"kind":"text","text":"("},{"kind":"externalParam","text":"headers"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Operations","preciseIdentifier":"s:14DiscogsService10OperationsO"},{"kind":"text","text":"."},{"kind":"typeIdentifier","text":"GetLabel","preciseIdentifier":"s:14DiscogsService10OperationsO8GetLabelO"},{"kind":"text","text":"."},{"kind":"typeIdentifier","text":"Output","preciseIdentifier":"s:14DiscogsService10OperationsO8GetLabelO6OutputO"},{"kind":"text","text":"."},{"kind":"typeIdentifier","text":"Ok","preciseIdentifier":"s:14DiscogsService10OperationsO8GetLabelO6OutputO2OkV"},{"kind":"text","text":"."},{"kind":"typeIdentifier","text":"Headers","preciseIdentifier":"s:14DiscogsService10OperationsO8GetLabelO6OutputO2OkV7HeadersV"},{"kind":"text","text":", "},{"kind":"externalParam","text":"body"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Operations","preciseIdentifier":"s:14DiscogsService10OperationsO"},{"kind":"text","text":"."},{"kind":"typeIdentifier","text":"GetLabel","preciseIdentifier":"s:14DiscogsService10OperationsO8GetLabelO"},{"kind":"text","text":"."},{"kind":"typeIdentifier","text":"Output","preciseIdentifier":"s:14DiscogsService10OperationsO8GetLabelO6OutputO"},{"kind":"text","text":"."},{"kind":"typeIdentifier","text":"Ok","preciseIdentifier":"s:14DiscogsService10OperationsO8GetLabelO6OutputO2OkV"},{"kind":"text","text":"."},{"kind":"typeIdentifier","text":"Body","preciseIdentifier":"s:14DiscogsService10OperationsO8GetLabelO6OutputO2OkV4BodyO"},{"kind":"text","text":")"}],"type":"topic"},"doc://DiscogsService/documentation/DiscogsService/Operations/GetLabel/Output/Ok-swift.struct/body-swift.property":{"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetLabel\/Output\/Ok-swift.struct\/body-swift.property","type":"topic","kind":"symbol","fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"body","kind":"identifier"},{"text":": ","kind":"text"},{"text":"Operations","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO"},{"text":".","kind":"text"},{"text":"GetLabel","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO8GetLabelO"},{"text":".","kind":"text"},{"text":"Output","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO8GetLabelO6OutputO"},{"text":".","kind":"text"},{"text":"Ok","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO8GetLabelO6OutputO2OkV"},{"text":".","kind":"text"},{"text":"Body","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO8GetLabelO6OutputO2OkV4BodyO"}],"title":"body","abstract":[{"type":"text","text":"Received HTTP response body"}],"role":"symbol","url":"\/documentation\/discogsservice\/operations\/getlabel\/output\/ok-swift.struct\/body-swift.property"},"doc://DiscogsService/documentation/DiscogsService/Operations/GetLabel/Output/Ok-swift.struct/Equatable-Implementations":{"title":"Equatable Implementations","type":"topic","url":"\/documentation\/discogsservice\/operations\/getlabel\/output\/ok-swift.struct\/equatable-implementations","role":"collectionGroup","kind":"article","abstract":[],"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetLabel\/Output\/Ok-swift.struct\/Equatable-Implementations"},"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"}}} |