rock-n-code/discogs-service
1
0
Fork 0
Code Pull Requests Releases 8 Activity
Files
428eedd89d5fdeaa951d06c140e317e0519686dd
discogs-service/docs/data/documentation/discogsservice/operations/getartistreleases/input/init(path:query:headers:).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
13 KiB
JSON
Raw Blame History

{"hierarchy":{"paths":[["doc:\/\/DiscogsService\/documentation\/DiscogsService","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/getArtistReleases","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/getArtistReleases\/Input"]]},"schemaVersion":{"patch":0,"major":0,"minor":3},"primaryContentSections":[{"declarations":[{"tokens":[{"kind":"keyword","text":"init"},{"kind":"text","text":"("},{"kind":"externalParam","text":"path"},{"kind":"text","text":": "},{"preciseIdentifier":"s:14DiscogsService10OperationsO","kind":"typeIdentifier","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations","text":"Operations"},{"kind":"text","text":"."},{"preciseIdentifier":"s:14DiscogsService10OperationsO17getArtistReleasesO","kind":"typeIdentifier","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/getArtistReleases","text":"getArtistReleases"},{"kind":"text","text":"."},{"preciseIdentifier":"s:14DiscogsService10OperationsO17getArtistReleasesO5InputV","kind":"typeIdentifier","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/getArtistReleases\/Input","text":"Input"},{"kind":"text","text":"."},{"preciseIdentifier":"s:14DiscogsService10OperationsO17getArtistReleasesO5InputV4PathV","kind":"typeIdentifier","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/getArtistReleases\/Input\/Path-swift.struct","text":"Path"},{"kind":"text","text":", "},{"kind":"externalParam","text":"query"},{"kind":"text","text":": "},{"preciseIdentifier":"s:14DiscogsService10OperationsO","kind":"typeIdentifier","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations","text":"Operations"},{"kind":"text","text":"."},{"preciseIdentifier":"s:14DiscogsService10OperationsO17getArtistReleasesO","kind":"typeIdentifier","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/getArtistReleases","text":"getArtistReleases"},{"kind":"text","text":"."},{"preciseIdentifier":"s:14DiscogsService10OperationsO17getArtistReleasesO5InputV","kind":"typeIdentifier","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/getArtistReleases\/Input","text":"Input"},{"kind":"text","text":"."},{"preciseIdentifier":"s:14DiscogsService10OperationsO17getArtistReleasesO5InputV5QueryV","kind":"typeIdentifier","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/getArtistReleases\/Input\/Query-swift.struct","text":"Query"},{"kind":"text","text":" = .init(), "},{"kind":"externalParam","text":"headers"},{"kind":"text","text":": "},{"preciseIdentifier":"s:14DiscogsService10OperationsO","kind":"typeIdentifier","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations","text":"Operations"},{"kind":"text","text":"."},{"preciseIdentifier":"s:14DiscogsService10OperationsO17getArtistReleasesO","kind":"typeIdentifier","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/getArtistReleases","text":"getArtistReleases"},{"kind":"text","text":"."},{"preciseIdentifier":"s:14DiscogsService10OperationsO17getArtistReleasesO5InputV","kind":"typeIdentifier","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/getArtistReleases\/Input","text":"Input"},{"kind":"text","text":"."},{"preciseIdentifier":"s:14DiscogsService10OperationsO17getArtistReleasesO5InputV7HeadersV","kind":"typeIdentifier","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/getArtistReleases\/Input\/Headers-swift.struct","text":"Headers"},{"kind":"text","text":" = .init())"}],"languages":["swift"],"platforms":["macOS"]}],"kind":"declarations"},{"kind":"parameters","parameters":[{"content":[{"type":"paragraph","inlineContent":[{"type":"text","text":""}]}],"name":"path"},{"content":[{"type":"paragraph","inlineContent":[{"type":"text","text":""}]}],"name":"query"},{"content":[{"type":"paragraph","inlineContent":[{"type":"text","text":""}]}],"name":"headers"}]}],"sections":[],"kind":"symbol","identifier":{"url":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/getArtistReleases\/Input\/init(path:query:headers:)","interfaceLanguage":"swift"},"metadata":{"role":"symbol","title":"init(path:query:headers:)","roleHeading":"Initializer","fragments":[{"kind":"identifier","text":"init"},{"kind":"text","text":"("},{"kind":"externalParam","text":"path"},{"kind":"text","text":": "},{"preciseIdentifier":"s:14DiscogsService10OperationsO","text":"Operations","kind":"typeIdentifier"},{"text":".","kind":"text"},{"preciseIdentifier":"s:14DiscogsService10OperationsO17getArtistReleasesO","text":"getArtistReleases","kind":"typeIdentifier"},{"text":".","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO17getArtistReleasesO5InputV","text":"Input"},{"kind":"text","text":"."},{"kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO17getArtistReleasesO5InputV4PathV","text":"Path"},{"text":", ","kind":"text"},{"text":"query","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:14DiscogsService10OperationsO","text":"Operations","kind":"typeIdentifier"},{"text":".","kind":"text"},{"kind":"typeIdentifier","text":"getArtistReleases","preciseIdentifier":"s:14DiscogsService10OperationsO17getArtistReleasesO"},{"text":".","kind":"text"},{"text":"Input","preciseIdentifier":"s:14DiscogsService10OperationsO17getArtistReleasesO5InputV","kind":"typeIdentifier"},{"text":".","kind":"text"},{"preciseIdentifier":"s:14DiscogsService10OperationsO17getArtistReleasesO5InputV5QueryV","text":"Query","kind":"typeIdentifier"},{"kind":"text","text":", "},{"kind":"externalParam","text":"headers"},{"kind":"text","text":": "},{"preciseIdentifier":"s:14DiscogsService10OperationsO","kind":"typeIdentifier","text":"Operations"},{"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":"Headers","preciseIdentifier":"s:14DiscogsService10OperationsO17getArtistReleasesO5InputV7HeadersV"},{"kind":"text","text":")"}],"externalID":"s:14DiscogsService10OperationsO17getArtistReleasesO5InputV4path5query7headersA2G4PathV_AG5QueryVAG7HeadersVtcfc","symbolKind":"init","modules":[{"name":"DiscogsService"}]},"abstract":[{"type":"text","text":"Creates a new "},{"type":"codeVoice","code":"Input"},{"type":"text","text":"."}],"variants":[{"paths":["\/documentation\/discogsservice\/operations\/getartistreleases\/input\/init(path:query:headers:)"],"traits":[{"interfaceLanguage":"swift"}]}],"references":{"doc://DiscogsService/documentation/DiscogsService/Operations/getArtistReleases/Input/Path-swift.struct":{"navigatorTitle":[{"text":"Path","kind":"identifier"}],"abstract":[],"role":"symbol","type":"topic","title":"Operations.getArtistReleases.Input.Path","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Path","kind":"identifier"}],"kind":"symbol","url":"\/documentation\/discogsservice\/operations\/getartistreleases\/input\/path-swift.struct","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/getArtistReleases\/Input\/Path-swift.struct"},"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/Input/Query-swift.struct":{"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/getArtistReleases\/Input\/Query-swift.struct","type":"topic","url":"\/documentation\/discogsservice\/operations\/getartistreleases\/input\/query-swift.struct","abstract":[],"role":"symbol","kind":"symbol","navigatorTitle":[{"text":"Query","kind":"identifier"}],"title":"Operations.getArtistReleases.Input.Query","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Query","kind":"identifier"}]},"doc://DiscogsService/documentation/DiscogsService/Operations/getArtistReleases/Input/init(path:query:headers:)":{"abstract":[{"text":"Creates a new ","type":"text"},{"type":"codeVoice","code":"Input"},{"text":".","type":"text"}],"role":"symbol","type":"topic","title":"init(path:query:headers:)","fragments":[{"text":"init","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"},{"preciseIdentifier":"s:14DiscogsService10OperationsO17getArtistReleasesO5InputV","text":"Input","kind":"typeIdentifier"},{"text":".","kind":"text"},{"preciseIdentifier":"s:14DiscogsService10OperationsO17getArtistReleasesO5InputV5QueryV","text":"Query","kind":"typeIdentifier"},{"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"},{"preciseIdentifier":"s:14DiscogsService10OperationsO17getArtistReleasesO5InputV","text":"Input","kind":"typeIdentifier"},{"text":".","kind":"text"},{"preciseIdentifier":"s:14DiscogsService10OperationsO17getArtistReleasesO5InputV7HeadersV","text":"Headers","kind":"typeIdentifier"},{"text":")","kind":"text"}],"kind":"symbol","url":"\/documentation\/discogsservice\/operations\/getartistreleases\/input\/init(path:query:headers:)","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/getArtistReleases\/Input\/init(path:query:headers:)"},"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":{"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":{"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"}}}
View Git Blame Copy Permalink