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
6.2 KiB
JSON
1 line
6.2 KiB
JSON
{"hierarchy":{"paths":[["doc:\/\/DiscogsService\/documentation\/DiscogsService","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetArtist","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetArtist\/Input"]]},"primaryContentSections":[{"kind":"declarations","declarations":[{"languages":["swift"],"tokens":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"path"},{"kind":"text","text":": "},{"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations","preciseIdentifier":"s:14DiscogsService10OperationsO","kind":"typeIdentifier","text":"Operations"},{"kind":"text","text":"."},{"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetArtist","preciseIdentifier":"s:14DiscogsService10OperationsO9GetArtistO","kind":"typeIdentifier","text":"GetArtist"},{"kind":"text","text":"."},{"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetArtist\/Input","preciseIdentifier":"s:14DiscogsService10OperationsO9GetArtistO5InputV","kind":"typeIdentifier","text":"Input"},{"kind":"text","text":"."},{"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetArtist\/Input\/Path-swift.struct","preciseIdentifier":"s:14DiscogsService10OperationsO9GetArtistO5InputV4PathV","kind":"typeIdentifier","text":"Path"}],"platforms":["macOS"]}]}],"schemaVersion":{"major":0,"minor":3,"patch":0},"metadata":{"title":"path","roleHeading":"Instance Property","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"path"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Operations","preciseIdentifier":"s:14DiscogsService10OperationsO"},{"kind":"text","text":"."},{"kind":"typeIdentifier","text":"GetArtist","preciseIdentifier":"s:14DiscogsService10OperationsO9GetArtistO"},{"kind":"text","text":"."},{"kind":"typeIdentifier","text":"Input","preciseIdentifier":"s:14DiscogsService10OperationsO9GetArtistO5InputV"},{"kind":"text","text":"."},{"kind":"typeIdentifier","text":"Path","preciseIdentifier":"s:14DiscogsService10OperationsO9GetArtistO5InputV4PathV"}],"externalID":"s:14DiscogsService10OperationsO9GetArtistO5InputV4pathAG4PathVvp","role":"symbol","symbolKind":"property","modules":[{"name":"DiscogsService"}]},"kind":"symbol","sections":[],"identifier":{"url":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetArtist\/Input\/path-swift.property","interfaceLanguage":"swift"},"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/discogsservice\/operations\/getartist\/input\/path-swift.property"]}],"references":{"doc://DiscogsService/documentation/DiscogsService/Operations/GetArtist/Input/Path-swift.struct":{"title":"Operations.GetArtist.Input.Path","url":"\/documentation\/discogsservice\/operations\/getartist\/input\/path-swift.struct","abstract":[],"type":"topic","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetArtist\/Input\/Path-swift.struct","kind":"symbol","role":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"Path"}],"navigatorTitle":[{"kind":"identifier","text":"Path"}]},"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":{"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/GetArtist/Input":{"title":"Operations.GetArtist.Input","url":"\/documentation\/discogsservice\/operations\/getartist\/input","abstract":[],"type":"topic","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetArtist\/Input","kind":"symbol","role":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"Input"}],"navigatorTitle":[{"text":"Input","kind":"identifier"}]},"doc://DiscogsService/documentation/DiscogsService/Operations/GetArtist":{"type":"topic","url":"\/documentation\/discogsservice\/operations\/getartist","abstract":[{"text":"Get information about an artist.","type":"text"}],"title":"Operations.GetArtist","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetArtist","kind":"symbol","role":"symbol","fragments":[{"text":"enum","kind":"keyword"},{"text":" ","kind":"text"},{"text":"GetArtist","kind":"identifier"}],"navigatorTitle":[{"text":"GetArtist","kind":"identifier"}]},"doc://DiscogsService/documentation/DiscogsService/Operations/GetArtist/Input/path-swift.property":{"title":"path","abstract":[],"url":"\/documentation\/discogsservice\/operations\/getartist\/input\/path-swift.property","role":"symbol","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetArtist\/Input\/path-swift.property","kind":"symbol","fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"path","kind":"identifier"},{"text":": ","kind":"text"},{"text":"Operations","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO"},{"text":".","kind":"text"},{"text":"GetArtist","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO9GetArtistO"},{"text":".","kind":"text"},{"preciseIdentifier":"s:14DiscogsService10OperationsO9GetArtistO5InputV","text":"Input","kind":"typeIdentifier"},{"text":".","kind":"text"},{"text":"Path","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO9GetArtistO5InputV4PathV"}],"type":"topic"}}} |