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
7.1 KiB
JSON
1 line
7.1 KiB
JSON
{"sections":[],"hierarchy":{"paths":[["doc:\/\/DiscogsService\/documentation\/DiscogsService","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetArtist","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetArtist\/Input","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetArtist\/Input\/Headers-swift.struct"]]},"metadata":{"role":"symbol","modules":[{"name":"DiscogsService"}],"externalID":"s:14DiscogsService10OperationsO9GetArtistO5InputV7HeadersV6acceptSay14OpenAPIRuntime23AcceptHeaderContentTypeVyAE010AcceptablemN0OGGvp","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"accept"},{"kind":"text","text":": ["},{"preciseIdentifier":"s:14OpenAPIRuntime23AcceptHeaderContentTypeV","kind":"typeIdentifier","text":"AcceptHeaderContentType"},{"text":"<","kind":"text"},{"text":"Operations","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO"},{"text":".","kind":"text"},{"text":"GetArtist","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO9GetArtistO"},{"text":".","kind":"text"},{"text":"AcceptableContentType","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO9GetArtistO21AcceptableContentTypeO"},{"kind":"text","text":">]"}],"symbolKind":"property","roleHeading":"Instance Property","title":"accept"},"kind":"symbol","primaryContentSections":[{"declarations":[{"languages":["swift"],"platforms":["macOS"],"tokens":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"accept","kind":"identifier"},{"text":": [","kind":"text"},{"text":"AcceptHeaderContentType","kind":"typeIdentifier","preciseIdentifier":"s:14OpenAPIRuntime23AcceptHeaderContentTypeV"},{"text":"<","kind":"text"},{"text":"Operations","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations"},{"text":".","kind":"text"},{"text":"GetArtist","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO9GetArtistO","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetArtist"},{"kind":"text","text":"."},{"text":"AcceptableContentType","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO9GetArtistO21AcceptableContentTypeO","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetArtist\/AcceptableContentType"},{"kind":"text","text":">]"}]}],"kind":"declarations"}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/discogsservice\/operations\/getartist\/input\/headers-swift.struct\/accept"]}],"schemaVersion":{"patch":0,"minor":3,"major":0},"identifier":{"url":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetArtist\/Input\/Headers-swift.struct\/accept","interfaceLanguage":"swift"},"references":{"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/AcceptableContentType":{"title":"Operations.GetArtist.AcceptableContentType","url":"\/documentation\/discogsservice\/operations\/getartist\/acceptablecontenttype","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetArtist\/AcceptableContentType","navigatorTitle":[{"kind":"identifier","text":"AcceptableContentType"}],"fragments":[{"kind":"keyword","text":"enum"},{"kind":"text","text":" "},{"kind":"identifier","text":"AcceptableContentType"}],"abstract":[],"kind":"symbol","role":"symbol","type":"topic"},"doc://DiscogsService/documentation/DiscogsService/Operations/GetArtist/Input/Headers-swift.struct/accept":{"url":"\/documentation\/discogsservice\/operations\/getartist\/input\/headers-swift.struct\/accept","abstract":[],"type":"topic","kind":"symbol","role":"symbol","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"accept"},{"kind":"text","text":": ["},{"preciseIdentifier":"s:14OpenAPIRuntime23AcceptHeaderContentTypeV","kind":"typeIdentifier","text":"AcceptHeaderContentType"},{"text":"<","kind":"text"},{"preciseIdentifier":"s:14DiscogsService10OperationsO","kind":"typeIdentifier","text":"Operations"},{"text":".","kind":"text"},{"preciseIdentifier":"s:14DiscogsService10OperationsO9GetArtistO","kind":"typeIdentifier","text":"GetArtist"},{"text":".","kind":"text"},{"preciseIdentifier":"s:14DiscogsService10OperationsO9GetArtistO21AcceptableContentTypeO","kind":"typeIdentifier","text":"AcceptableContentType"},{"text":">]","kind":"text"}],"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetArtist\/Input\/Headers-swift.struct\/accept","title":"accept"},"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/Headers-swift.struct":{"title":"Operations.GetArtist.Input.Headers","url":"\/documentation\/discogsservice\/operations\/getartist\/input\/headers-swift.struct","abstract":[],"type":"topic","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetArtist\/Input\/Headers-swift.struct","kind":"symbol","role":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"Headers"}],"navigatorTitle":[{"kind":"identifier","text":"Headers"}]},"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/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"}]}}} |