Files
discogs-service/docs/data/documentation/discogsservice/client/getartistreleases(path:query:headers:).json
T
javier d01b60e6dd Added the Rate Limiting headers (#7)
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>
2025-10-13 13:09:10 +00:00

1 line
17 KiB
JSON

{"sections":[],"hierarchy":{"paths":[["doc:\/\/DiscogsService\/documentation\/DiscogsService","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Client"]]},"metadata":{"roleHeading":"Instance Method","symbolKind":"method","externalID":"s:14DiscogsService11APIProtocolPAAE17getArtistReleases4path5query7headersAA10OperationsO03GeteF0O6OutputOAK5InputV4PathV_AO5QueryVAO7HeadersVtYaKF::SYNTHESIZED::s:14DiscogsService6ClientV","modules":[{"name":"DiscogsService"}],"role":"symbol","extendedModule":"DiscogsService","fragments":[{"kind":"keyword","text":"func"},{"text":" ","kind":"text"},{"text":"getArtistReleases","kind":"identifier"},{"text":"(","kind":"text"},{"text":"path","kind":"externalParam"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO","text":"Operations"},{"text":".","kind":"text"},{"preciseIdentifier":"s:14DiscogsService10OperationsO17GetArtistReleasesO","text":"GetArtistReleases","kind":"typeIdentifier"},{"text":".","kind":"text"},{"preciseIdentifier":"s:14DiscogsService10OperationsO17GetArtistReleasesO5InputV","kind":"typeIdentifier","text":"Input"},{"kind":"text","text":"."},{"preciseIdentifier":"s:14DiscogsService10OperationsO17GetArtistReleasesO5InputV4PathV","kind":"typeIdentifier","text":"Path"},{"text":", ","kind":"text"},{"text":"query","kind":"externalParam"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO","text":"Operations"},{"kind":"text","text":"."},{"kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO17GetArtistReleasesO","text":"GetArtistReleases"},{"text":".","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO17GetArtistReleasesO5InputV","text":"Input"},{"kind":"text","text":"."},{"kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO17GetArtistReleasesO5InputV5QueryV","text":"Query"},{"kind":"text","text":", "},{"kind":"externalParam","text":"headers"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","text":"Operations","preciseIdentifier":"s:14DiscogsService10OperationsO"},{"kind":"text","text":"."},{"preciseIdentifier":"s:14DiscogsService10OperationsO17GetArtistReleasesO","text":"GetArtistReleases","kind":"typeIdentifier"},{"text":".","kind":"text"},{"preciseIdentifier":"s:14DiscogsService10OperationsO17GetArtistReleasesO5InputV","text":"Input","kind":"typeIdentifier"},{"text":".","kind":"text"},{"preciseIdentifier":"s:14DiscogsService10OperationsO17GetArtistReleasesO5InputV7HeadersV","text":"Headers","kind":"typeIdentifier"},{"text":") ","kind":"text"},{"text":"async","kind":"keyword"},{"text":" ","kind":"text"},{"text":"throws","kind":"keyword"},{"text":" -> ","kind":"text"},{"preciseIdentifier":"s:14DiscogsService10OperationsO","text":"Operations","kind":"typeIdentifier"},{"text":".","kind":"text"},{"preciseIdentifier":"s:14DiscogsService10OperationsO17GetArtistReleasesO","text":"GetArtistReleases","kind":"typeIdentifier"},{"text":".","kind":"text"},{"preciseIdentifier":"s:14DiscogsService10OperationsO17GetArtistReleasesO6OutputO","text":"Output","kind":"typeIdentifier"}],"title":"getArtistReleases(path:query:headers:)"},"abstract":[{"type":"text","text":"Get information about releases of an artist."}],"kind":"symbol","primaryContentSections":[{"kind":"declarations","declarations":[{"platforms":["macOS"],"languages":["swift"],"tokens":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"getArtistReleases"},{"kind":"text","text":"("},{"kind":"externalParam","text":"path"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Operations","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations","preciseIdentifier":"s:14DiscogsService10OperationsO"},{"kind":"text","text":"."},{"kind":"typeIdentifier","text":"GetArtistReleases","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetArtistReleases","preciseIdentifier":"s:14DiscogsService10OperationsO17GetArtistReleasesO"},{"kind":"text","text":"."},{"kind":"typeIdentifier","text":"Input","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetArtistReleases\/Input","preciseIdentifier":"s:14DiscogsService10OperationsO17GetArtistReleasesO5InputV"},{"kind":"text","text":"."},{"kind":"typeIdentifier","text":"Path","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetArtistReleases\/Input\/Path-swift.struct","preciseIdentifier":"s:14DiscogsService10OperationsO17GetArtistReleasesO5InputV4PathV"},{"kind":"text","text":", "},{"kind":"externalParam","text":"query"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Operations","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations","preciseIdentifier":"s:14DiscogsService10OperationsO"},{"kind":"text","text":"."},{"kind":"typeIdentifier","text":"GetArtistReleases","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetArtistReleases","preciseIdentifier":"s:14DiscogsService10OperationsO17GetArtistReleasesO"},{"kind":"text","text":"."},{"kind":"typeIdentifier","text":"Input","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetArtistReleases\/Input","preciseIdentifier":"s:14DiscogsService10OperationsO17GetArtistReleasesO5InputV"},{"kind":"text","text":"."},{"kind":"typeIdentifier","text":"Query","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetArtistReleases\/Input\/Query-swift.struct","preciseIdentifier":"s:14DiscogsService10OperationsO17GetArtistReleasesO5InputV5QueryV"},{"kind":"text","text":" = .init(), "},{"kind":"externalParam","text":"headers"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Operations","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations","preciseIdentifier":"s:14DiscogsService10OperationsO"},{"kind":"text","text":"."},{"kind":"typeIdentifier","text":"GetArtistReleases","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetArtistReleases","preciseIdentifier":"s:14DiscogsService10OperationsO17GetArtistReleasesO"},{"kind":"text","text":"."},{"kind":"typeIdentifier","text":"Input","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetArtistReleases\/Input","preciseIdentifier":"s:14DiscogsService10OperationsO17GetArtistReleasesO5InputV"},{"kind":"text","text":"."},{"kind":"typeIdentifier","text":"Headers","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetArtistReleases\/Input\/Headers-swift.struct","preciseIdentifier":"s:14DiscogsService10OperationsO17GetArtistReleasesO5InputV7HeadersV"},{"kind":"text","text":" = .init()) "},{"kind":"keyword","text":"async"},{"kind":"text","text":" "},{"kind":"keyword","text":"throws"},{"kind":"text","text":" -> "},{"kind":"typeIdentifier","text":"Operations","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations","preciseIdentifier":"s:14DiscogsService10OperationsO"},{"kind":"text","text":"."},{"kind":"typeIdentifier","text":"GetArtistReleases","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetArtistReleases","preciseIdentifier":"s:14DiscogsService10OperationsO17GetArtistReleasesO"},{"kind":"text","text":"."},{"kind":"typeIdentifier","text":"Output","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetArtistReleases\/Output","preciseIdentifier":"s:14DiscogsService10OperationsO17GetArtistReleasesO6OutputO"}]}]},{"kind":"content","content":[{"type":"heading","level":2,"anchor":"discussion","text":"Discussion"},{"type":"paragraph","inlineContent":[{"text":"Returns a list of releases and masters associated with an artist.","type":"text"}]},{"type":"paragraph","inlineContent":[{"text":"This endpoint supports pagination.","type":"text"}]},{"type":"aside","content":[{"inlineContent":[{"text":"HTTP ","type":"text"},{"code":"GET \/artists\/{artist_id}\/releases","type":"codeVoice"},{"text":".","type":"text"}],"type":"paragraph"}],"style":"note","name":"Remark"},{"type":"aside","content":[{"inlineContent":[{"text":"Generated from ","type":"text"},{"code":"#\/paths\/\/artists\/{artist_id}\/releases\/get(getArtistReleases)","type":"codeVoice"},{"text":".","type":"text"}],"type":"paragraph"}],"style":"note","name":"Remark"}]}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/discogsservice\/client\/getartistreleases(path:query:headers:)"]}],"schemaVersion":{"minor":3,"major":0,"patch":0},"identifier":{"url":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Client\/getArtistReleases(path:query:headers:)","interfaceLanguage":"swift"},"references":{"doc://DiscogsService/documentation/DiscogsService/Operations/GetArtistReleases/Input/Query-swift.struct":{"abstract":[],"kind":"symbol","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Query","kind":"identifier"}],"type":"topic","url":"\/documentation\/discogsservice\/operations\/getartistreleases\/input\/query-swift.struct","role":"symbol","navigatorTitle":[{"text":"Query","kind":"identifier"}],"title":"Operations.GetArtistReleases.Input.Query","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetArtistReleases\/Input\/Query-swift.struct"},"doc://DiscogsService/documentation/DiscogsService/Client/getArtistReleases(path:query:headers:)":{"kind":"symbol","role":"symbol","type":"topic","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Client\/getArtistReleases(path:query:headers:)","abstract":[{"type":"text","text":"Get information about releases of an artist."}],"fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"getArtistReleases","kind":"identifier"},{"text":"(","kind":"text"},{"text":"path","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"Operations","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO"},{"text":".","kind":"text"},{"text":"GetArtistReleases","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO17GetArtistReleasesO"},{"text":".","kind":"text"},{"text":"Input","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO17GetArtistReleasesO5InputV"},{"text":".","kind":"text"},{"text":"Path","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO17GetArtistReleasesO5InputV4PathV"},{"text":", ","kind":"text"},{"text":"query","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"Operations","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO"},{"text":".","kind":"text"},{"text":"GetArtistReleases","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO17GetArtistReleasesO"},{"text":".","kind":"text"},{"text":"Input","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO17GetArtistReleasesO5InputV"},{"text":".","kind":"text"},{"text":"Query","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO17GetArtistReleasesO5InputV5QueryV"},{"text":", ","kind":"text"},{"text":"headers","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"Operations","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO"},{"text":".","kind":"text"},{"text":"GetArtistReleases","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO17GetArtistReleasesO"},{"text":".","kind":"text"},{"text":"Input","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO17GetArtistReleasesO5InputV"},{"text":".","kind":"text"},{"text":"Headers","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO17GetArtistReleasesO5InputV7HeadersV"},{"text":") ","kind":"text"},{"text":"async","kind":"keyword"},{"text":" ","kind":"text"},{"text":"throws","kind":"keyword"},{"text":" -> ","kind":"text"},{"text":"Operations","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO"},{"text":".","kind":"text"},{"text":"GetArtistReleases","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO17GetArtistReleasesO"},{"text":".","kind":"text"},{"text":"Output","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO17GetArtistReleasesO6OutputO"}],"url":"\/documentation\/discogsservice\/client\/getartistreleases(path:query:headers:)","title":"getArtistReleases(path:query:headers:)"},"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":{"title":"DiscogsService","url":"\/documentation\/discogsservice","type":"topic","role":"collection","abstract":[],"kind":"symbol","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService"},"doc://DiscogsService/documentation/DiscogsService/Operations/GetArtistReleases/Input/Headers-swift.struct":{"type":"topic","kind":"symbol","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetArtistReleases\/Input\/Headers-swift.struct","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Headers","kind":"identifier"}],"title":"Operations.GetArtistReleases.Input.Headers","role":"symbol","abstract":[],"url":"\/documentation\/discogsservice\/operations\/getartistreleases\/input\/headers-swift.struct","navigatorTitle":[{"text":"Headers","kind":"identifier"}]},"doc://DiscogsService/documentation/DiscogsService/Operations/GetArtistReleases/Input":{"abstract":[],"kind":"symbol","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Input","kind":"identifier"}],"type":"topic","url":"\/documentation\/discogsservice\/operations\/getartistreleases\/input","role":"symbol","navigatorTitle":[{"text":"Input","kind":"identifier"}],"title":"Operations.GetArtistReleases.Input","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetArtistReleases\/Input"},"doc://DiscogsService/documentation/DiscogsService/Client":{"url":"\/documentation\/discogsservice\/client","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Client","role":"symbol","navigatorTitle":[{"kind":"identifier","text":"Client"}],"kind":"symbol","title":"Client","abstract":[{"text":"The Discogs API v2.0 is a RESTful interface to Discogs data. You can access JSON-formatted information about Database objects such as ","type":"text"},{"inlineContent":[{"type":"text","text":"Artists"}],"type":"emphasis"},{"text":", ","type":"text"},{"inlineContent":[{"type":"text","text":"Releases"}],"type":"emphasis"},{"text":", and ","type":"text"},{"inlineContent":[{"type":"text","text":"Labels"}],"type":"emphasis"},{"text":". Your application can also manage ","type":"text"},{"inlineContent":[{"type":"text","text":"User Collections"}],"type":"emphasis"},{"text":" and ","type":"text"},{"inlineContent":[{"type":"text","text":"Wantlists"}],"type":"emphasis"},{"text":", create ","type":"text"},{"inlineContent":[{"type":"text","text":"Marketplace"}],"type":"emphasis"},{"text":" listings, and more.","type":"text"}],"fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"Client"}],"type":"topic"},"doc://DiscogsService/documentation/DiscogsService/Operations/GetArtistReleases":{"abstract":[{"type":"text","text":"Get information about releases of an artist."}],"kind":"symbol","fragments":[{"text":"enum","kind":"keyword"},{"text":" ","kind":"text"},{"text":"GetArtistReleases","kind":"identifier"}],"type":"topic","url":"\/documentation\/discogsservice\/operations\/getartistreleases","role":"symbol","navigatorTitle":[{"text":"GetArtistReleases","kind":"identifier"}],"title":"Operations.GetArtistReleases","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetArtistReleases"},"doc://DiscogsService/documentation/DiscogsService/Operations/GetArtistReleases/Output":{"type":"topic","title":"Operations.GetArtistReleases.Output","abstract":[],"url":"\/documentation\/discogsservice\/operations\/getartistreleases\/output","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetArtistReleases\/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/GetArtistReleases/Input/Path-swift.struct":{"role":"symbol","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Path","kind":"identifier"}],"kind":"symbol","title":"Operations.GetArtistReleases.Input.Path","type":"topic","navigatorTitle":[{"text":"Path","kind":"identifier"}],"url":"\/documentation\/discogsservice\/operations\/getartistreleases\/input\/path-swift.struct","abstract":[],"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetArtistReleases\/Input\/Path-swift.struct"}}}