rock-n-code/discogs-service
1
0
Fork 0
Code Pull Requests Releases 8 Activity
Files
8cf19e02c8f2311656e1e1a4e77d3390896192bd
discogs-service/docs/data/documentation/discogsservice/operations/getartistreleases/output/ok-swift.property.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
7.6 KiB
JSON
Raw Blame History

{"schemaVersion":{"major":0,"minor":3,"patch":0},"abstract":[{"type":"text","text":"The associated value of the enum case if "},{"type":"codeVoice","code":"self"},{"type":"text","text":" is "},{"type":"codeVoice","code":".ok"},{"type":"text","text":"."}],"metadata":{"title":"ok","modules":[{"name":"DiscogsService"}],"symbolKind":"property","externalID":"s:14DiscogsService10OperationsO17GetArtistReleasesO6OutputO2okAG2OkVvp","role":"symbol","roleHeading":"Instance Property","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"ok"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO","text":"Operations"},{"kind":"text","text":"."},{"kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO17GetArtistReleasesO","text":"GetArtistReleases"},{"kind":"text","text":"."},{"kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO17GetArtistReleasesO6OutputO","text":"Output"},{"kind":"text","text":"."},{"kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO17GetArtistReleasesO6OutputO2OkV","text":"Ok"}]},"identifier":{"url":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetArtistReleases\/Output\/ok-swift.property","interfaceLanguage":"swift"},"sections":[],"variants":[{"paths":["\/documentation\/discogsservice\/operations\/getartistreleases\/output\/ok-swift.property"],"traits":[{"interfaceLanguage":"swift"}]}],"hierarchy":{"paths":[["doc:\/\/DiscogsService\/documentation\/DiscogsService","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetArtistReleases","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetArtistReleases\/Output"]]},"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"ok"},{"kind":"text","text":": "},{"kind":"typeIdentifier","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations","preciseIdentifier":"s:14DiscogsService10OperationsO","text":"Operations"},{"kind":"text","text":"."},{"kind":"typeIdentifier","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetArtistReleases","preciseIdentifier":"s:14DiscogsService10OperationsO17GetArtistReleasesO","text":"GetArtistReleases"},{"kind":"text","text":"."},{"kind":"typeIdentifier","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetArtistReleases\/Output","preciseIdentifier":"s:14DiscogsService10OperationsO17GetArtistReleasesO6OutputO","text":"Output"},{"kind":"text","text":"."},{"kind":"typeIdentifier","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetArtistReleases\/Output\/Ok-swift.struct","preciseIdentifier":"s:14DiscogsService10OperationsO17GetArtistReleasesO6OutputO2OkV","text":"Ok"},{"kind":"text","text":" { "},{"kind":"keyword","text":"get"},{"kind":"text","text":" "},{"kind":"keyword","text":"throws"},{"kind":"text","text":" }"}],"languages":["swift"],"platforms":["macOS"]}]},{"kind":"content","content":[{"type":"heading","level":2,"text":"Discussion","anchor":"discussion"},{"type":"aside","content":[{"type":"paragraph","inlineContent":[{"text":"An error if ","type":"text"},{"type":"codeVoice","code":"self"},{"text":" is not ","type":"text"},{"type":"codeVoice","code":".ok"},{"text":".","type":"text"}]}],"name":"Throws","style":"note"},{"type":"aside","content":[{"type":"paragraph","inlineContent":[{"text":"","type":"text"},{"type":"codeVoice","code":".ok"},{"text":".","type":"text"}]}],"name":"See Also","style":"note"}]}],"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/Output/ok-swift.property":{"role":"symbol","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetArtistReleases\/Output\/ok-swift.property","title":"ok","type":"topic","abstract":[{"text":"The associated value of the enum case if ","type":"text"},{"type":"codeVoice","code":"self"},{"type":"text","text":" is "},{"type":"codeVoice","code":".ok"},{"type":"text","text":"."}],"fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"text":"ok","kind":"identifier"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:14DiscogsService10OperationsO","kind":"typeIdentifier","text":"Operations"},{"text":".","kind":"text"},{"preciseIdentifier":"s:14DiscogsService10OperationsO17GetArtistReleasesO","text":"GetArtistReleases","kind":"typeIdentifier"},{"kind":"text","text":"."},{"preciseIdentifier":"s:14DiscogsService10OperationsO17GetArtistReleasesO6OutputO","kind":"typeIdentifier","text":"Output"},{"kind":"text","text":"."},{"preciseIdentifier":"s:14DiscogsService10OperationsO17GetArtistReleasesO6OutputO2OkV","text":"Ok","kind":"typeIdentifier"}],"kind":"symbol","url":"\/documentation\/discogsservice\/operations\/getartistreleases\/output\/ok-swift.property"},"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"}]},"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/Output/Ok-swift.struct":{"type":"topic","title":"Operations.GetArtistReleases.Output.Ok","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetArtistReleases\/Output\/Ok-swift.struct","abstract":[],"navigatorTitle":[{"kind":"identifier","text":"Ok"}],"kind":"symbol","url":"\/documentation\/discogsservice\/operations\/getartistreleases\/output\/ok-swift.struct","role":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"Ok"}]},"doc://DiscogsService/documentation/DiscogsService":{"type":"topic","title":"DiscogsService","url":"\/documentation\/discogsservice","role":"collection","abstract":[],"kind":"symbol","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService"}}}
View Git Blame Copy Permalink