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
12 KiB
JSON
1 line
12 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\/GetMasterVersions","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetMasterVersions\/Output","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetMasterVersions\/Output\/Ok-swift.struct"]]},"primaryContentSections":[{"declarations":[{"tokens":[{"text":"init","kind":"keyword"},{"text":"(","kind":"text"},{"text":"headers","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"Operations","kind":"typeIdentifier","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations","preciseIdentifier":"s:14DiscogsService10OperationsO"},{"text":".","kind":"text"},{"text":"GetMasterVersions","kind":"typeIdentifier","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetMasterVersions","preciseIdentifier":"s:14DiscogsService10OperationsO17GetMasterVersionsO"},{"text":".","kind":"text"},{"text":"Output","kind":"typeIdentifier","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetMasterVersions\/Output","preciseIdentifier":"s:14DiscogsService10OperationsO17GetMasterVersionsO6OutputO"},{"text":".","kind":"text"},{"text":"Ok","kind":"typeIdentifier","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetMasterVersions\/Output\/Ok-swift.struct","preciseIdentifier":"s:14DiscogsService10OperationsO17GetMasterVersionsO6OutputO2OkV"},{"text":".","kind":"text"},{"text":"Headers","kind":"typeIdentifier","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetMasterVersions\/Output\/Ok-swift.struct\/Headers-swift.struct","preciseIdentifier":"s:14DiscogsService10OperationsO17GetMasterVersionsO6OutputO2OkV7HeadersV"},{"text":", ","kind":"text"},{"text":"body","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"Operations","kind":"typeIdentifier","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations","preciseIdentifier":"s:14DiscogsService10OperationsO"},{"text":".","kind":"text"},{"text":"GetMasterVersions","kind":"typeIdentifier","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetMasterVersions","preciseIdentifier":"s:14DiscogsService10OperationsO17GetMasterVersionsO"},{"text":".","kind":"text"},{"text":"Output","kind":"typeIdentifier","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetMasterVersions\/Output","preciseIdentifier":"s:14DiscogsService10OperationsO17GetMasterVersionsO6OutputO"},{"text":".","kind":"text"},{"text":"Ok","kind":"typeIdentifier","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetMasterVersions\/Output\/Ok-swift.struct","preciseIdentifier":"s:14DiscogsService10OperationsO17GetMasterVersionsO6OutputO2OkV"},{"text":".","kind":"text"},{"text":"Body","kind":"typeIdentifier","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetMasterVersions\/Output\/Ok-swift.struct\/Body-swift.enum","preciseIdentifier":"s:14DiscogsService10OperationsO17GetMasterVersionsO6OutputO2OkV4BodyO"},{"text":")","kind":"text"}],"languages":["swift"],"platforms":["macOS"]}],"kind":"declarations"},{"parameters":[{"name":"headers","content":[{"type":"paragraph","inlineContent":[{"text":"Received HTTP response headers","type":"text"}]}]},{"name":"body","content":[{"type":"paragraph","inlineContent":[{"text":"Received HTTP response body","type":"text"}]}]}],"kind":"parameters"}],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetMasterVersions\/Output\/Ok-swift.struct\/init(headers:body:)"},"kind":"symbol","abstract":[{"type":"text","text":"Creates a new "},{"type":"codeVoice","code":"Ok"},{"type":"text","text":"."}],"metadata":{"role":"symbol","fragments":[{"text":"init","kind":"identifier"},{"text":"(","kind":"text"},{"text":"headers","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"Operations","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO"},{"text":".","kind":"text"},{"text":"GetMasterVersions","preciseIdentifier":"s:14DiscogsService10OperationsO17GetMasterVersionsO","kind":"typeIdentifier"},{"text":".","kind":"text"},{"text":"Output","preciseIdentifier":"s:14DiscogsService10OperationsO17GetMasterVersionsO6OutputO","kind":"typeIdentifier"},{"text":".","kind":"text"},{"text":"Ok","preciseIdentifier":"s:14DiscogsService10OperationsO17GetMasterVersionsO6OutputO2OkV","kind":"typeIdentifier"},{"text":".","kind":"text"},{"text":"Headers","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO17GetMasterVersionsO6OutputO2OkV7HeadersV"},{"text":", ","kind":"text"},{"text":"body","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"Operations","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO"},{"text":".","kind":"text"},{"text":"GetMasterVersions","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO17GetMasterVersionsO"},{"text":".","kind":"text"},{"text":"Output","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO17GetMasterVersionsO6OutputO"},{"text":".","kind":"text"},{"text":"Ok","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO17GetMasterVersionsO6OutputO2OkV"},{"text":".","kind":"text"},{"text":"Body","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO17GetMasterVersionsO6OutputO2OkV4BodyO"},{"text":")","kind":"text"}],"externalID":"s:14DiscogsService10OperationsO17GetMasterVersionsO6OutputO2OkV7headers4bodyA2I7HeadersV_AI4BodyOtcfc","modules":[{"name":"DiscogsService"}],"title":"init(headers:body:)","symbolKind":"init","roleHeading":"Initializer"},"variants":[{"paths":["\/documentation\/discogsservice\/operations\/getmasterversions\/output\/ok-swift.struct\/init(headers:body:)"],"traits":[{"interfaceLanguage":"swift"}]}],"references":{"doc://DiscogsService/documentation/DiscogsService/Operations/GetMasterVersions/Output/Ok-swift.struct":{"url":"\/documentation\/discogsservice\/operations\/getmasterversions\/output\/ok-swift.struct","role":"symbol","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Ok","kind":"identifier"}],"title":"Operations.GetMasterVersions.Output.Ok","navigatorTitle":[{"text":"Ok","kind":"identifier"}],"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetMasterVersions\/Output\/Ok-swift.struct","kind":"symbol","abstract":[],"type":"topic"},"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/GetMasterVersions/Output/Ok-swift.struct/init(headers:body:)":{"url":"\/documentation\/discogsservice\/operations\/getmasterversions\/output\/ok-swift.struct\/init(headers:body:)","role":"symbol","fragments":[{"text":"init","kind":"identifier"},{"text":"(","kind":"text"},{"text":"headers","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"Operations","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO"},{"text":".","kind":"text"},{"text":"GetMasterVersions","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO17GetMasterVersionsO"},{"text":".","kind":"text"},{"text":"Output","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO17GetMasterVersionsO6OutputO"},{"text":".","kind":"text"},{"text":"Ok","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO17GetMasterVersionsO6OutputO2OkV"},{"text":".","kind":"text"},{"text":"Headers","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO17GetMasterVersionsO6OutputO2OkV7HeadersV"},{"text":", ","kind":"text"},{"text":"body","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"Operations","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO"},{"text":".","kind":"text"},{"text":"GetMasterVersions","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO17GetMasterVersionsO"},{"text":".","kind":"text"},{"text":"Output","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO17GetMasterVersionsO6OutputO"},{"text":".","kind":"text"},{"text":"Ok","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO17GetMasterVersionsO6OutputO2OkV"},{"text":".","kind":"text"},{"text":"Body","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO17GetMasterVersionsO6OutputO2OkV4BodyO"},{"text":")","kind":"text"}],"title":"init(headers:body:)","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetMasterVersions\/Output\/Ok-swift.struct\/init(headers:body:)","kind":"symbol","abstract":[{"type":"text","text":"Creates a new "},{"type":"codeVoice","code":"Ok"},{"type":"text","text":"."}],"type":"topic"},"doc://DiscogsService/documentation/DiscogsService/Operations/GetMasterVersions/Output/Ok-swift.struct/Body-swift.enum":{"url":"\/documentation\/discogsservice\/operations\/getmasterversions\/output\/ok-swift.struct\/body-swift.enum","role":"symbol","fragments":[{"text":"enum","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Body","kind":"identifier"}],"title":"Operations.GetMasterVersions.Output.Ok.Body","navigatorTitle":[{"text":"Body","kind":"identifier"}],"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetMasterVersions\/Output\/Ok-swift.struct\/Body-swift.enum","kind":"symbol","abstract":[],"type":"topic"},"doc://DiscogsService/documentation/DiscogsService/Operations/GetMasterVersions":{"url":"\/documentation\/discogsservice\/operations\/getmasterversions","role":"symbol","fragments":[{"text":"enum","kind":"keyword"},{"text":" ","kind":"text"},{"text":"GetMasterVersions","kind":"identifier"}],"title":"Operations.GetMasterVersions","navigatorTitle":[{"text":"GetMasterVersions","kind":"identifier"}],"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetMasterVersions","kind":"symbol","abstract":[{"type":"text","text":"Get information about the versions of a master release."}],"type":"topic"},"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/GetMasterVersions/Output/Ok-swift.struct/Headers-swift.struct":{"url":"\/documentation\/discogsservice\/operations\/getmasterversions\/output\/ok-swift.struct\/headers-swift.struct","role":"symbol","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Headers","kind":"identifier"}],"title":"Operations.GetMasterVersions.Output.Ok.Headers","navigatorTitle":[{"text":"Headers","kind":"identifier"}],"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetMasterVersions\/Output\/Ok-swift.struct\/Headers-swift.struct","kind":"symbol","abstract":[],"type":"topic"},"doc://DiscogsService/documentation/DiscogsService/Operations/GetMasterVersions/Output":{"url":"\/documentation\/discogsservice\/operations\/getmasterversions\/output","role":"symbol","fragments":[{"text":"enum","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Output","kind":"identifier"}],"title":"Operations.GetMasterVersions.Output","navigatorTitle":[{"text":"Output","kind":"identifier"}],"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetMasterVersions\/Output","kind":"symbol","abstract":[],"type":"topic"}}} |