rock-n-code/discogs-service
1
0
Fork 0
Code Pull Requests Releases 8 Activity
Files
428eedd89d5fdeaa951d06c140e317e0519686dd
discogs-service/docs/data/documentation/discogsservice/apiprotocol/getartistreleases(_:).json
T
javier 428eedd89d Implemented the Services and Database GET endpoints (#2) 
This PR contains the work done to include the define the information sections of the `OpenAPI` specification document and all the `GET` endpoints of the _Service_ and _Database_ categories.

The following endpoints have been defined in the document, and also tested manually with `Swift`:
* GET `/`
* GET `/artists/{artist_id}`
* GET `/artists/{artist_id}/releases`
* GET `/labels/{label_id}`
* GET `/labels/{label_id}/releases`
* GET `/masters/{master_id}`
* GET `/masters/{master_id}/versions`
* GET `/releases/{release_id}`
* GET `/releases/{release_id}/rating`
* GET `/releases/{release_id}/rating/{username}`
* GET `/releases/{release_id}/stats`
* GET `/database/search`

In addition, a first version of the _Github Pages_ documentation has been generated from the `DocC` documentation catalog, and the generated Swift code from the `openapi.yaml` file.

Reviewed-on: #2
Co-authored-by: Javier Cicchelli <javier@rock-n-code.com>
Co-committed-by: Javier Cicchelli <javier@rock-n-code.com>
2025-10-09 23:51:39 +00:00

1 line
9.2 KiB
JSON
Raw Blame History

{"schemaVersion":{"minor":3,"major":0,"patch":0},"sections":[],"abstract":[{"type":"text","text":"Get information about releases of an artist."}],"metadata":{"required":true,"title":"getArtistReleases(_:)","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"getArtistReleases","kind":"identifier"},{"text":"(","kind":"text"},{"text":"Operations","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO"},{"text":".","kind":"text"},{"text":"getArtistReleases","preciseIdentifier":"s:14DiscogsService10OperationsO17getArtistReleasesO","kind":"typeIdentifier"},{"text":".","kind":"text"},{"text":"Input","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO17getArtistReleasesO5InputV"},{"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"},{"text":".","kind":"text"},{"text":"Output","preciseIdentifier":"s:14DiscogsService10OperationsO17getArtistReleasesO6OutputO","kind":"typeIdentifier"}],"symbolKind":"method","roleHeading":"Instance Method","modules":[{"name":"DiscogsService"}],"role":"symbol","externalID":"s:14DiscogsService11APIProtocolP17getArtistReleasesyAA10OperationsOADO6OutputOAG5InputVYaKF"},"kind":"symbol","identifier":{"url":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/APIProtocol\/getArtistReleases(_:)","interfaceLanguage":"swift"},"primaryContentSections":[{"declarations":[{"platforms":["macOS"],"tokens":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"getArtistReleases"},{"kind":"text","text":"("},{"kind":"externalParam","text":"_"},{"kind":"text","text":" "},{"kind":"internalParam","text":"input"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","text":"Operations","preciseIdentifier":"s:14DiscogsService10OperationsO","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations"},{"kind":"text","text":"."},{"kind":"typeIdentifier","text":"getArtistReleases","preciseIdentifier":"s:14DiscogsService10OperationsO17getArtistReleasesO","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/getArtistReleases"},{"kind":"text","text":"."},{"kind":"typeIdentifier","text":"Input","preciseIdentifier":"s:14DiscogsService10OperationsO17getArtistReleasesO5InputV","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/getArtistReleases\/Input"},{"kind":"text","text":") "},{"kind":"keyword","text":"async"},{"kind":"text","text":" "},{"kind":"keyword","text":"throws"},{"kind":"text","text":" -> "},{"kind":"typeIdentifier","text":"Operations","preciseIdentifier":"s:14DiscogsService10OperationsO","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations"},{"kind":"text","text":"."},{"kind":"typeIdentifier","text":"getArtistReleases","preciseIdentifier":"s:14DiscogsService10OperationsO17getArtistReleasesO","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/getArtistReleases"},{"kind":"text","text":"."},{"kind":"typeIdentifier","text":"Output","preciseIdentifier":"s:14DiscogsService10OperationsO17getArtistReleasesO6OutputO","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/getArtistReleases\/Output"}],"languages":["swift"]}],"kind":"declarations"},{"kind":"content","content":[{"level":2,"anchor":"discussion","text":"Discussion","type":"heading"},{"inlineContent":[{"type":"text","text":"Returns a list of releases and masters associated with an artist."}],"type":"paragraph"},{"inlineContent":[{"type":"text","text":"This endpoint supports pagination."}],"type":"paragraph"},{"style":"note","type":"aside","name":"Remark","content":[{"inlineContent":[{"text":"HTTP ","type":"text"},{"code":"GET \/artists\/{artist_id}\/releases","type":"codeVoice"},{"type":"text","text":"."}],"type":"paragraph"}]},{"style":"note","type":"aside","name":"Remark","content":[{"inlineContent":[{"type":"text","text":"Generated from "},{"type":"codeVoice","code":"#\/paths\/\/artists\/{artist_id}\/releases\/get(getArtistReleases)"},{"type":"text","text":"."}],"type":"paragraph"}]}]}],"hierarchy":{"paths":[["doc:\/\/DiscogsService\/documentation\/DiscogsService","doc:\/\/DiscogsService\/documentation\/DiscogsService\/APIProtocol"]]},"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/discogsservice\/apiprotocol\/getartistreleases(_:)"]}],"references":{"doc://DiscogsService/documentation/DiscogsService/APIProtocol":{"navigatorTitle":[{"kind":"identifier","text":"APIProtocol"}],"fragments":[{"kind":"keyword","text":"protocol"},{"kind":"text","text":" "},{"kind":"identifier","text":"APIProtocol"}],"url":"\/documentation\/discogsservice\/apiprotocol","role":"symbol","type":"topic","kind":"symbol","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/APIProtocol","abstract":[{"type":"text","text":"A type that performs HTTP operations defined by the OpenAPI document."}],"title":"APIProtocol"},"doc://DiscogsService/documentation/DiscogsService/Operations/getArtistReleases/Input":{"navigatorTitle":[{"kind":"identifier","text":"Input"}],"fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"Input"}],"url":"\/documentation\/discogsservice\/operations\/getartistreleases\/input","role":"symbol","type":"topic","kind":"symbol","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/getArtistReleases\/Input","abstract":[],"title":"Operations.getArtistReleases.Input"},"doc://DiscogsService/documentation/DiscogsService/Operations":{"navigatorTitle":[{"kind":"identifier","text":"Operations"}],"fragments":[{"kind":"keyword","text":"enum"},{"kind":"text","text":" "},{"kind":"identifier","text":"Operations"}],"url":"\/documentation\/discogsservice\/operations","role":"symbol","type":"topic","kind":"symbol","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations","abstract":[{"text":"API operations, with input and output types, generated from ","type":"text"},{"code":"#\/paths","type":"codeVoice"},{"text":" in the OpenAPI document.","type":"text"}],"title":"Operations"},"doc://DiscogsService/documentation/DiscogsService":{"url":"\/documentation\/discogsservice","abstract":[],"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService","kind":"symbol","role":"collection","type":"topic","title":"DiscogsService"},"doc://DiscogsService/documentation/DiscogsService/Operations/getArtistReleases":{"navigatorTitle":[{"kind":"identifier","text":"getArtistReleases"}],"fragments":[{"text":"enum","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"getArtistReleases"}],"url":"\/documentation\/discogsservice\/operations\/getartistreleases","role":"symbol","type":"topic","kind":"symbol","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/getArtistReleases","abstract":[{"type":"text","text":"Get information about releases of an artist."}],"title":"Operations.getArtistReleases"},"doc://DiscogsService/documentation/DiscogsService/Operations/getArtistReleases/Output":{"navigatorTitle":[{"text":"Output","kind":"identifier"}],"fragments":[{"kind":"keyword","text":"enum"},{"text":" ","kind":"text"},{"text":"Output","kind":"identifier"}],"url":"\/documentation\/discogsservice\/operations\/getartistreleases\/output","role":"symbol","type":"topic","kind":"symbol","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/getArtistReleases\/Output","abstract":[],"title":"Operations.getArtistReleases.Output"},"doc://DiscogsService/documentation/DiscogsService/APIProtocol/getArtistReleases(_:)":{"url":"\/documentation\/discogsservice\/apiprotocol\/getartistreleases(_:)","type":"topic","title":"getArtistReleases(_:)","abstract":[{"text":"Get information about releases of an artist.","type":"text"}],"required":true,"kind":"symbol","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/APIProtocol\/getArtistReleases(_:)","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"getArtistReleases","kind":"identifier"},{"text":"(","kind":"text"},{"text":"Operations","preciseIdentifier":"s:14DiscogsService10OperationsO","kind":"typeIdentifier"},{"text":".","kind":"text"},{"text":"getArtistReleases","preciseIdentifier":"s:14DiscogsService10OperationsO17getArtistReleasesO","kind":"typeIdentifier"},{"text":".","kind":"text"},{"text":"Input","preciseIdentifier":"s:14DiscogsService10OperationsO17getArtistReleasesO5InputV","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"},{"text":".","kind":"text"},{"text":"Output","preciseIdentifier":"s:14DiscogsService10OperationsO17getArtistReleasesO6OutputO","kind":"typeIdentifier"}],"role":"symbol"}}}
View Git Blame Copy Permalink