javier
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
5.3 KiB
JSON
1 line
5.3 KiB
JSON
{"sections":[],"hierarchy":{"paths":[["doc:\/\/DiscogsService\/documentation\/DiscogsService","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetLabelReleases","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetLabelReleases\/Output"]]},"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetLabelReleases\/Output\/undocumented(statusCode:_:)"},"abstract":[{"type":"text","text":"Undocumented response."}],"variants":[{"paths":["\/documentation\/discogsservice\/operations\/getlabelreleases\/output\/undocumented(statuscode:_:)"],"traits":[{"interfaceLanguage":"swift"}]}],"schemaVersion":{"major":0,"patch":0,"minor":3},"metadata":{"symbolKind":"case","role":"symbol","modules":[{"name":"DiscogsService"}],"fragments":[{"text":"case","kind":"keyword"},{"text":" ","kind":"text"},{"text":"undocumented","kind":"identifier"},{"text":"(","kind":"text"},{"text":"statusCode","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"Int","preciseIdentifier":"s:Si","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"UndocumentedPayload","preciseIdentifier":"s:14OpenAPIRuntime19UndocumentedPayloadV","kind":"typeIdentifier"},{"text":")","kind":"text"}],"roleHeading":"Case","title":"Operations.GetLabelReleases.Output.undocumented(statusCode:_:)","externalID":"s:14DiscogsService10OperationsO16GetLabelReleasesO6OutputO12undocumentedyAGSi_14OpenAPIRuntime19UndocumentedPayloadVtcAGmF"},"primaryContentSections":[{"kind":"declarations","declarations":[{"languages":["swift"],"tokens":[{"text":"case","kind":"keyword"},{"text":" ","kind":"text"},{"text":"undocumented","kind":"identifier"},{"text":"(","kind":"text"},{"text":"statusCode","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"Int","preciseIdentifier":"s:Si","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"UndocumentedPayload","preciseIdentifier":"s:14OpenAPIRuntime19UndocumentedPayloadV","kind":"typeIdentifier"},{"text":")","kind":"text"}],"platforms":["macOS"]}]},{"kind":"content","content":[{"type":"heading","level":2,"anchor":"discussion","text":"Discussion"},{"type":"paragraph","inlineContent":[{"text":"A response with a code that is not documented in the OpenAPI document.","type":"text"}]}]}],"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/GetLabelReleases/Output":{"abstract":[],"kind":"symbol","fragments":[{"text":"enum","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Output","kind":"identifier"}],"type":"topic","url":"\/documentation\/discogsservice\/operations\/getlabelreleases\/output","role":"symbol","navigatorTitle":[{"text":"Output","kind":"identifier"}],"title":"Operations.GetLabelReleases.Output","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetLabelReleases\/Output"},"doc://DiscogsService/documentation/DiscogsService/Operations/GetLabelReleases":{"abstract":[{"text":"Get information about the releases of a label.","type":"text"}],"kind":"symbol","fragments":[{"text":"enum","kind":"keyword"},{"text":" ","kind":"text"},{"text":"GetLabelReleases","kind":"identifier"}],"type":"topic","url":"\/documentation\/discogsservice\/operations\/getlabelreleases","role":"symbol","navigatorTitle":[{"text":"GetLabelReleases","kind":"identifier"}],"title":"Operations.GetLabelReleases","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetLabelReleases"},"doc://DiscogsService/documentation/DiscogsService/Operations/GetLabelReleases/Output/undocumented(statusCode:_:)":{"abstract":[{"type":"text","text":"Undocumented response."}],"role":"symbol","fragments":[{"text":"case","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"undocumented"},{"kind":"text","text":"("},{"text":"statusCode","kind":"externalParam"},{"kind":"text","text":": "},{"preciseIdentifier":"s:Si","kind":"typeIdentifier","text":"Int"},{"text":", ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:14OpenAPIRuntime19UndocumentedPayloadV","text":"UndocumentedPayload"},{"text":")","kind":"text"}],"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetLabelReleases\/Output\/undocumented(statusCode:_:)","type":"topic","kind":"symbol","url":"\/documentation\/discogsservice\/operations\/getlabelreleases\/output\/undocumented(statuscode:_:)","title":"Operations.GetLabelReleases.Output.undocumented(statusCode:_:)"},"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"}}} |