rock-n-code/discogs-service
1
0
Fork 0
Code Pull Requests Releases 8 Activity
Files
de5b4ff5d0506f8354e28ef31060eb09f754aece
discogs-service/docs/data/documentation/discogsservice/client/getartistreleases(path:query:headers:).json
T
javier de5b4ff5d0 Implemented the missing Database endpoints (#8) 
This PR contains the work done to declare the missing, non-GET endpoints of the *Database* section in the [Discogs API documentation](https://www.discogs.com/developers#page:database) into the `OpenAPI` specification document.

Furthermore, documentation extensions have been defined for the `APIProtocol` and `Client` types in the `DocC` documentation catalog to match the categories of these endpoint calls to the categories in the Discogs documentation.

Reviewed-on: #8
Co-authored-by: Javier Cicchelli <javier@rock-n-code.com>
Co-committed-by: Javier Cicchelli <javier@rock-n-code.com>
2025-10-13 15:20:20 +00:00

1 line
17 KiB
JSON
Raw Blame History

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