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
{"sections":[],"schemaVersion":{"minor":3,"patch":0,"major":0},"hierarchy":{"paths":[["doc:\/\/DiscogsService\/documentation\/DiscogsService","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetRelease","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetRelease\/Output"]]},"primaryContentSections":[{"declarations":[{"languages":["swift"],"platforms":["macOS"],"tokens":[{"kind":"keyword","text":"case"},{"kind":"text","text":" "},{"kind":"identifier","text":"ok"},{"kind":"text","text":"("},{"preciseIdentifier":"s:14DiscogsService10OperationsO","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations","kind":"typeIdentifier","text":"Operations"},{"kind":"text","text":"."},{"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetRelease","preciseIdentifier":"s:14DiscogsService10OperationsO10GetReleaseO","kind":"typeIdentifier","text":"GetRelease"},{"kind":"text","text":"."},{"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetRelease\/Output","preciseIdentifier":"s:14DiscogsService10OperationsO10GetReleaseO6OutputO","kind":"typeIdentifier","text":"Output"},{"kind":"text","text":"."},{"preciseIdentifier":"s:14DiscogsService10OperationsO10GetReleaseO6OutputO2OkV","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetRelease\/Output\/Ok-swift.struct","kind":"typeIdentifier","text":"Ok"},{"kind":"text","text":")"}]}],"kind":"declarations"},{"kind":"content","content":[{"type":"heading","level":2,"anchor":"discussion","text":"Discussion"},{"content":[{"inlineContent":[{"type":"text","text":"Generated from "},{"code":"#\/paths\/\/releases\/{release_id}\/get(getRelease)\/responses\/200","type":"codeVoice"},{"type":"text","text":"."}],"type":"paragraph"}],"type":"aside","name":"Remark","style":"note"},{"inlineContent":[{"text":"HTTP response code: ","type":"text"},{"type":"codeVoice","code":"200 ok"},{"type":"text","text":"."}],"type":"paragraph"}]}],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetRelease\/Output\/ok(_:)"},"kind":"symbol","abstract":[{"type":"text","text":"Successfully retrieved release details."}],"metadata":{"role":"symbol","fragments":[{"kind":"keyword","text":"case"},{"kind":"text","text":" "},{"kind":"identifier","text":"ok"},{"kind":"text","text":"("},{"preciseIdentifier":"s:14DiscogsService10OperationsO","kind":"typeIdentifier","text":"Operations"},{"kind":"text","text":"."},{"preciseIdentifier":"s:14DiscogsService10OperationsO10GetReleaseO","kind":"typeIdentifier","text":"GetRelease"},{"text":".","kind":"text"},{"preciseIdentifier":"s:14DiscogsService10OperationsO10GetReleaseO6OutputO","kind":"typeIdentifier","text":"Output"},{"kind":"text","text":"."},{"preciseIdentifier":"s:14DiscogsService10OperationsO10GetReleaseO6OutputO2OkV","kind":"typeIdentifier","text":"Ok"},{"kind":"text","text":")"}],"externalID":"s:14DiscogsService10OperationsO10GetReleaseO6OutputO2okyA2G2OkVcAGmF","modules":[{"name":"DiscogsService"}],"title":"Operations.GetRelease.Output.ok(_:)","symbolKind":"case","roleHeading":"Case"},"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/discogsservice\/operations\/getrelease\/output\/ok(_:)"]}],"references":{"doc://DiscogsService/documentation/DiscogsService/Operations/GetRelease":{"type":"topic","title":"Operations.GetRelease","abstract":[{"text":"Get information about a release","type":"text"}],"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetRelease","navigatorTitle":[{"text":"GetRelease","kind":"identifier"}],"kind":"symbol","url":"\/documentation\/discogsservice\/operations\/getrelease","role":"symbol","fragments":[{"kind":"keyword","text":"enum"},{"kind":"text","text":" "},{"kind":"identifier","text":"GetRelease"}]},"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/GetRelease/Output/Ok-swift.struct":{"role":"symbol","title":"Operations.GetRelease.Output.Ok","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetRelease\/Output\/Ok-swift.struct","type":"topic","abstract":[],"fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Ok","kind":"identifier"}],"url":"\/documentation\/discogsservice\/operations\/getrelease\/output\/ok-swift.struct","kind":"symbol","navigatorTitle":[{"text":"Ok","kind":"identifier"}]},"doc://DiscogsService/documentation/DiscogsService/Operations/GetRelease/Output/ok(_:)":{"url":"\/documentation\/discogsservice\/operations\/getrelease\/output\/ok(_:)","role":"symbol","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":"GetRelease","preciseIdentifier":"s:14DiscogsService10OperationsO10GetReleaseO"},{"kind":"text","text":"."},{"kind":"typeIdentifier","text":"Output","preciseIdentifier":"s:14DiscogsService10OperationsO10GetReleaseO6OutputO"},{"kind":"text","text":"."},{"kind":"typeIdentifier","text":"Ok","preciseIdentifier":"s:14DiscogsService10OperationsO10GetReleaseO6OutputO2OkV"},{"kind":"text","text":")"}],"title":"Operations.GetRelease.Output.ok(_:)","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetRelease\/Output\/ok(_:)","abstract":[{"type":"text","text":"Successfully retrieved release details."}],"kind":"symbol","type":"topic"},"doc://DiscogsService/documentation/DiscogsService/Operations/GetRelease/Output":{"type":"topic","abstract":[],"title":"Operations.GetRelease.Output","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetRelease\/Output","navigatorTitle":[{"kind":"identifier","text":"Output"}],"kind":"symbol","url":"\/documentation\/discogsservice\/operations\/getrelease\/output","role":"symbol","fragments":[{"kind":"keyword","text":"enum"},{"kind":"text","text":" "},{"kind":"identifier","text":"Output"}]},"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"}]}}} |