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
8.0 KiB
JSON
1 line
8.0 KiB
JSON
{"metadata":{"roleHeading":"Instance Property","modules":[{"name":"DiscogsService"}],"role":"symbol","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"body"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Operations","preciseIdentifier":"s:14DiscogsService10OperationsO"},{"kind":"text","text":"."},{"kind":"typeIdentifier","text":"GetReleaseRating","preciseIdentifier":"s:14DiscogsService10OperationsO16GetReleaseRatingO"},{"kind":"text","text":"."},{"kind":"typeIdentifier","text":"Output","preciseIdentifier":"s:14DiscogsService10OperationsO16GetReleaseRatingO6OutputO"},{"kind":"text","text":"."},{"kind":"typeIdentifier","text":"Ok","preciseIdentifier":"s:14DiscogsService10OperationsO16GetReleaseRatingO6OutputO2OkV"},{"kind":"text","text":"."},{"kind":"typeIdentifier","text":"Body","preciseIdentifier":"s:14DiscogsService10OperationsO16GetReleaseRatingO6OutputO2OkV4BodyO"}],"symbolKind":"property","externalID":"s:14DiscogsService10OperationsO16GetReleaseRatingO6OutputO2OkV4bodyAI4BodyOvp","title":"body"},"primaryContentSections":[{"declarations":[{"languages":["swift"],"tokens":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"body"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Operations","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations","preciseIdentifier":"s:14DiscogsService10OperationsO"},{"kind":"text","text":"."},{"kind":"typeIdentifier","text":"GetReleaseRating","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetReleaseRating","preciseIdentifier":"s:14DiscogsService10OperationsO16GetReleaseRatingO"},{"kind":"text","text":"."},{"kind":"typeIdentifier","text":"Output","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetReleaseRating\/Output","preciseIdentifier":"s:14DiscogsService10OperationsO16GetReleaseRatingO6OutputO"},{"kind":"text","text":"."},{"kind":"typeIdentifier","text":"Ok","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetReleaseRating\/Output\/Ok-swift.struct","preciseIdentifier":"s:14DiscogsService10OperationsO16GetReleaseRatingO6OutputO2OkV"},{"kind":"text","text":"."},{"kind":"typeIdentifier","text":"Body","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetReleaseRating\/Output\/Ok-swift.struct\/Body-swift.enum","preciseIdentifier":"s:14DiscogsService10OperationsO16GetReleaseRatingO6OutputO2OkV4BodyO"}],"platforms":["macOS"]}],"kind":"declarations"}],"variants":[{"paths":["\/documentation\/discogsservice\/operations\/getreleaserating\/output\/ok-swift.struct\/body-swift.property"],"traits":[{"interfaceLanguage":"swift"}]}],"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"]]},"schemaVersion":{"major":0,"patch":0,"minor":3},"kind":"symbol","sections":[],"abstract":[{"type":"text","text":"Received HTTP response body"}],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetReleaseRating\/Output\/Ok-swift.struct\/body-swift.property"},"references":{"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/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/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/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.property":{"role":"symbol","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"body"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO","text":"Operations"},{"kind":"text","text":"."},{"kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO16GetReleaseRatingO","text":"GetReleaseRating"},{"kind":"text","text":"."},{"kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO16GetReleaseRatingO6OutputO","text":"Output"},{"kind":"text","text":"."},{"kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO16GetReleaseRatingO6OutputO2OkV","text":"Ok"},{"kind":"text","text":"."},{"kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO16GetReleaseRatingO6OutputO2OkV4BodyO","text":"Body"}],"kind":"symbol","title":"body","type":"topic","url":"\/documentation\/discogsservice\/operations\/getreleaserating\/output\/ok-swift.struct\/body-swift.property","abstract":[{"type":"text","text":"Received HTTP response body"}],"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetReleaseRating\/Output\/Ok-swift.struct\/body-swift.property"},"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/documentation/DiscogsService":{"title":"DiscogsService","url":"\/documentation\/discogsservice","type":"topic","role":"collection","abstract":[],"kind":"symbol","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService"}}} |