Files
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
7.4 KiB
JSON

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