de5b4ff5d0
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>
1 line
6.9 KiB
JSON
1 line
6.9 KiB
JSON
{"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetArtist\/Output\/ok(_:)"},"hierarchy":{"paths":[["doc:\/\/DiscogsService\/documentation\/DiscogsService","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetArtist","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetArtist\/Output"]]},"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"kind":"keyword","text":"case"},{"kind":"text","text":" "},{"kind":"identifier","text":"ok"},{"kind":"text","text":"("},{"kind":"typeIdentifier","text":"Operations","preciseIdentifier":"s:14DiscogsService10OperationsO","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations"},{"kind":"text","text":"."},{"kind":"typeIdentifier","text":"GetArtist","preciseIdentifier":"s:14DiscogsService10OperationsO9GetArtistO","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetArtist"},{"kind":"text","text":"."},{"kind":"typeIdentifier","text":"Output","preciseIdentifier":"s:14DiscogsService10OperationsO9GetArtistO6OutputO","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetArtist\/Output"},{"kind":"text","text":"."},{"kind":"typeIdentifier","text":"Ok","preciseIdentifier":"s:14DiscogsService10OperationsO9GetArtistO6OutputO2OkV","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetArtist\/Output\/Ok-swift.struct"},{"kind":"text","text":")"}],"platforms":["macOS"],"languages":["swift"]}]},{"kind":"content","content":[{"anchor":"discussion","type":"heading","text":"Discussion","level":2},{"content":[{"inlineContent":[{"type":"text","text":"Generated from "},{"type":"codeVoice","code":"#\/paths\/\/artists\/{artist_id}\/get(getArtist)\/responses\/200"},{"type":"text","text":"."}],"type":"paragraph"}],"type":"aside","name":"Remark","style":"note"},{"type":"paragraph","inlineContent":[{"text":"HTTP response code: ","type":"text"},{"type":"codeVoice","code":"200 ok"},{"text":".","type":"text"}]}]}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/discogsservice\/operations\/getartist\/output\/ok(_:)"]}],"abstract":[{"type":"text","text":"Successfully retrieved artist details."}],"metadata":{"role":"symbol","title":"Operations.GetArtist.Output.ok(_:)","externalID":"s:14DiscogsService10OperationsO9GetArtistO6OutputO2okyA2G2OkVcAGmF","modules":[{"name":"DiscogsService"}],"roleHeading":"Case","fragments":[{"kind":"keyword","text":"case"},{"kind":"text","text":" "},{"kind":"identifier","text":"ok"},{"kind":"text","text":"("},{"kind":"typeIdentifier","text":"Operations","preciseIdentifier":"s:14DiscogsService10OperationsO"},{"kind":"text","text":"."},{"kind":"typeIdentifier","text":"GetArtist","preciseIdentifier":"s:14DiscogsService10OperationsO9GetArtistO"},{"kind":"text","text":"."},{"kind":"typeIdentifier","text":"Output","preciseIdentifier":"s:14DiscogsService10OperationsO9GetArtistO6OutputO"},{"kind":"text","text":"."},{"kind":"typeIdentifier","text":"Ok","preciseIdentifier":"s:14DiscogsService10OperationsO9GetArtistO6OutputO2OkV"},{"kind":"text","text":")"}],"symbolKind":"case"},"kind":"symbol","schemaVersion":{"patch":0,"minor":3,"major":0},"sections":[],"references":{"doc://DiscogsService/documentation/DiscogsService/Operations/GetArtist/Output":{"role":"symbol","title":"Operations.GetArtist.Output","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetArtist\/Output","type":"topic","abstract":[],"fragments":[{"text":"enum","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Output","kind":"identifier"}],"url":"\/documentation\/discogsservice\/operations\/getartist\/output","kind":"symbol","navigatorTitle":[{"text":"Output","kind":"identifier"}]},"doc://DiscogsService/documentation/DiscogsService/Operations/GetArtist/Output/ok(_:)":{"type":"topic","title":"Operations.GetArtist.Output.ok(_:)","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetArtist\/Output\/ok(_:)","abstract":[{"text":"Successfully retrieved artist details.","type":"text"}],"kind":"symbol","url":"\/documentation\/discogsservice\/operations\/getartist\/output\/ok(_:)","role":"symbol","fragments":[{"text":"case","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"ok"},{"kind":"text","text":"("},{"kind":"typeIdentifier","text":"Operations","preciseIdentifier":"s:14DiscogsService10OperationsO"},{"kind":"text","text":"."},{"kind":"typeIdentifier","text":"GetArtist","preciseIdentifier":"s:14DiscogsService10OperationsO9GetArtistO"},{"kind":"text","text":"."},{"kind":"typeIdentifier","text":"Output","preciseIdentifier":"s:14DiscogsService10OperationsO9GetArtistO6OutputO"},{"kind":"text","text":"."},{"kind":"typeIdentifier","text":"Ok","preciseIdentifier":"s:14DiscogsService10OperationsO9GetArtistO6OutputO2OkV"},{"kind":"text","text":")"}]},"doc://DiscogsService/documentation/DiscogsService/Operations/GetArtist":{"fragments":[{"text":"enum","kind":"keyword"},{"text":" ","kind":"text"},{"text":"GetArtist","kind":"identifier"}],"type":"topic","title":"Operations.GetArtist","url":"\/documentation\/discogsservice\/operations\/getartist","role":"symbol","abstract":[{"text":"Get information about an artist.","type":"text"}],"kind":"symbol","navigatorTitle":[{"text":"GetArtist","kind":"identifier"}],"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetArtist"},"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":{"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/GetArtist/Output/Ok-swift.struct":{"role":"symbol","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetArtist\/Output\/Ok-swift.struct","title":"Operations.GetArtist.Output.Ok","type":"topic","abstract":[],"fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Ok","kind":"identifier"}],"kind":"symbol","url":"\/documentation\/discogsservice\/operations\/getartist\/output\/ok-swift.struct","navigatorTitle":[{"text":"Ok","kind":"identifier"}]}}} |