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
{"sections":[],"identifier":{"url":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetArtist\/Output\/Ok-swift.struct\/init(headers:body:)","interfaceLanguage":"swift"},"schemaVersion":{"minor":3,"patch":0,"major":0},"hierarchy":{"paths":[["doc:\/\/DiscogsService\/documentation\/DiscogsService","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetArtist","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetArtist\/Output","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetArtist\/Output\/Ok-swift.struct"]]},"metadata":{"title":"init(headers:body:)","modules":[{"name":"DiscogsService"}],"externalID":"s:14DiscogsService10OperationsO9GetArtistO6OutputO2OkV7headers4bodyA2I7HeadersV_AI4BodyOtcfc","roleHeading":"Initializer","fragments":[{"kind":"identifier","text":"init"},{"kind":"text","text":"("},{"kind":"externalParam","text":"headers"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO","text":"Operations"},{"kind":"text","text":"."},{"kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO9GetArtistO","text":"GetArtist"},{"kind":"text","text":"."},{"kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO9GetArtistO6OutputO","text":"Output"},{"kind":"text","text":"."},{"kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO9GetArtistO6OutputO2OkV","text":"Ok"},{"kind":"text","text":"."},{"kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO9GetArtistO6OutputO2OkV7HeadersV","text":"Headers"},{"kind":"text","text":", "},{"kind":"externalParam","text":"body"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO","text":"Operations"},{"kind":"text","text":"."},{"kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO9GetArtistO","text":"GetArtist"},{"kind":"text","text":"."},{"kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO9GetArtistO6OutputO","text":"Output"},{"kind":"text","text":"."},{"kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO9GetArtistO6OutputO2OkV","text":"Ok"},{"kind":"text","text":"."},{"kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO9GetArtistO6OutputO2OkV4BodyO","text":"Body"},{"kind":"text","text":")"}],"symbolKind":"init","role":"symbol"},"abstract":[{"text":"Creates a new ","type":"text"},{"code":"Ok","type":"codeVoice"},{"text":".","type":"text"}],"kind":"symbol","variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/discogsservice\/operations\/getartist\/output\/ok-swift.struct\/init(headers:body:)"]}],"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"kind":"keyword","text":"init"},{"kind":"text","text":"("},{"kind":"externalParam","text":"headers"},{"kind":"text","text":": "},{"kind":"typeIdentifier","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations","text":"Operations","preciseIdentifier":"s:14DiscogsService10OperationsO"},{"kind":"text","text":"."},{"kind":"typeIdentifier","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetArtist","text":"GetArtist","preciseIdentifier":"s:14DiscogsService10OperationsO9GetArtistO"},{"kind":"text","text":"."},{"kind":"typeIdentifier","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetArtist\/Output","text":"Output","preciseIdentifier":"s:14DiscogsService10OperationsO9GetArtistO6OutputO"},{"kind":"text","text":"."},{"kind":"typeIdentifier","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetArtist\/Output\/Ok-swift.struct","text":"Ok","preciseIdentifier":"s:14DiscogsService10OperationsO9GetArtistO6OutputO2OkV"},{"kind":"text","text":"."},{"kind":"typeIdentifier","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetArtist\/Output\/Ok-swift.struct\/Headers-swift.struct","text":"Headers","preciseIdentifier":"s:14DiscogsService10OperationsO9GetArtistO6OutputO2OkV7HeadersV"},{"kind":"text","text":", "},{"kind":"externalParam","text":"body"},{"kind":"text","text":": "},{"kind":"typeIdentifier","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations","text":"Operations","preciseIdentifier":"s:14DiscogsService10OperationsO"},{"kind":"text","text":"."},{"kind":"typeIdentifier","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetArtist","text":"GetArtist","preciseIdentifier":"s:14DiscogsService10OperationsO9GetArtistO"},{"kind":"text","text":"."},{"kind":"typeIdentifier","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetArtist\/Output","text":"Output","preciseIdentifier":"s:14DiscogsService10OperationsO9GetArtistO6OutputO"},{"kind":"text","text":"."},{"kind":"typeIdentifier","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetArtist\/Output\/Ok-swift.struct","text":"Ok","preciseIdentifier":"s:14DiscogsService10OperationsO9GetArtistO6OutputO2OkV"},{"kind":"text","text":"."},{"kind":"typeIdentifier","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetArtist\/Output\/Ok-swift.struct\/Body-swift.enum","text":"Body","preciseIdentifier":"s:14DiscogsService10OperationsO9GetArtistO6OutputO2OkV4BodyO"},{"kind":"text","text":")"}],"platforms":["macOS"],"languages":["swift"]}]},{"parameters":[{"name":"headers","content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"Received HTTP response headers"}]}]},{"name":"body","content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"Received HTTP response body"}]}]}],"kind":"parameters"}],"references":{"doc://DiscogsService/documentation/DiscogsService/Operations/GetArtist/Output/Ok-swift.struct":{"type":"topic","url":"\/documentation\/discogsservice\/operations\/getartist\/output\/ok-swift.struct","abstract":[],"title":"Operations.GetArtist.Output.Ok","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetArtist\/Output\/Ok-swift.struct","kind":"symbol","role":"symbol","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Ok","kind":"identifier"}],"navigatorTitle":[{"text":"Ok","kind":"identifier"}]},"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/Output":{"type":"topic","url":"\/documentation\/discogsservice\/operations\/getartist\/output","abstract":[],"title":"Operations.GetArtist.Output","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetArtist\/Output","kind":"symbol","role":"symbol","fragments":[{"text":"enum","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Output","kind":"identifier"}],"navigatorTitle":[{"text":"Output","kind":"identifier"}]},"doc://DiscogsService/documentation/DiscogsService/Operations/GetArtist/Output/Ok-swift.struct/Headers-swift.struct":{"type":"topic","url":"\/documentation\/discogsservice\/operations\/getartist\/output\/ok-swift.struct\/headers-swift.struct","abstract":[],"title":"Operations.GetArtist.Output.Ok.Headers","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetArtist\/Output\/Ok-swift.struct\/Headers-swift.struct","kind":"symbol","role":"symbol","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Headers","kind":"identifier"}],"navigatorTitle":[{"text":"Headers","kind":"identifier"}]},"doc://DiscogsService/documentation/DiscogsService/Operations/GetArtist/Output/Ok-swift.struct/Body-swift.enum":{"type":"topic","url":"\/documentation\/discogsservice\/operations\/getartist\/output\/ok-swift.struct\/body-swift.enum","abstract":[],"title":"Operations.GetArtist.Output.Ok.Body","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetArtist\/Output\/Ok-swift.struct\/Body-swift.enum","kind":"symbol","role":"symbol","fragments":[{"text":"enum","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Body","kind":"identifier"}],"navigatorTitle":[{"text":"Body","kind":"identifier"}]},"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":{"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/Output/Ok-swift.struct/init(headers:body:)":{"role":"symbol","fragments":[{"text":"init","kind":"identifier"},{"text":"(","kind":"text"},{"text":"headers","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"Operations","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO"},{"text":".","kind":"text"},{"text":"GetArtist","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO9GetArtistO"},{"text":".","kind":"text"},{"text":"Output","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO9GetArtistO6OutputO"},{"text":".","kind":"text"},{"text":"Ok","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO9GetArtistO6OutputO2OkV"},{"text":".","kind":"text"},{"text":"Headers","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO9GetArtistO6OutputO2OkV7HeadersV"},{"text":", ","kind":"text"},{"text":"body","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"Operations","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO"},{"text":".","kind":"text"},{"text":"GetArtist","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO9GetArtistO"},{"text":".","kind":"text"},{"text":"Output","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO9GetArtistO6OutputO"},{"text":".","kind":"text"},{"text":"Ok","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO9GetArtistO6OutputO2OkV"},{"text":".","kind":"text"},{"text":"Body","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO9GetArtistO6OutputO2OkV4BodyO"},{"text":")","kind":"text"}],"type":"topic","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetArtist\/Output\/Ok-swift.struct\/init(headers:body:)","url":"\/documentation\/discogsservice\/operations\/getartist\/output\/ok-swift.struct\/init(headers:body:)","kind":"symbol","abstract":[{"text":"Creates a new ","type":"text"},{"code":"Ok","type":"codeVoice"},{"text":".","type":"text"}],"title":"init(headers:body:)"}}} |