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
8.4 KiB
JSON
1 line
8.4 KiB
JSON
{"schemaVersion":{"major":0,"minor":3,"patch":0},"abstract":[{"type":"text","text":"A filter by release year."}],"metadata":{"title":"released","symbolKind":"property","modules":[{"name":"DiscogsService"}],"externalID":"s:14DiscogsService10OperationsO17GetMasterVersionsO5InputV5QueryV8releasedSSSgvp","role":"symbol","roleHeading":"Instance Property","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"released"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Components","preciseIdentifier":"s:14DiscogsService10ComponentsO"},{"kind":"text","text":"."},{"preciseIdentifier":"s:14DiscogsService10ComponentsO10ParametersO","text":"Parameters","kind":"typeIdentifier"},{"text":".","kind":"text"},{"kind":"typeIdentifier","text":"Released","preciseIdentifier":"s:14DiscogsService10ComponentsO10ParametersO8Releaseda"},{"text":"?","kind":"text"}]},"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetMasterVersions\/Input\/Query-swift.struct\/released"},"sections":[],"variants":[{"paths":["\/documentation\/discogsservice\/operations\/getmasterversions\/input\/query-swift.struct\/released"],"traits":[{"interfaceLanguage":"swift"}]}],"hierarchy":{"paths":[["doc:\/\/DiscogsService\/documentation\/DiscogsService","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetMasterVersions","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetMasterVersions\/Input","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetMasterVersions\/Input\/Query-swift.struct"]]},"primaryContentSections":[{"kind":"declarations","declarations":[{"languages":["swift"],"tokens":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"released"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Components","preciseIdentifier":"s:14DiscogsService10ComponentsO","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components"},{"kind":"text","text":"."},{"kind":"typeIdentifier","text":"Parameters","preciseIdentifier":"s:14DiscogsService10ComponentsO10ParametersO","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Parameters"},{"kind":"text","text":"."},{"kind":"typeIdentifier","text":"Released","preciseIdentifier":"s:14DiscogsService10ComponentsO10ParametersO8Releaseda","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Parameters\/Released"},{"kind":"text","text":"?"}],"platforms":["macOS"]}]},{"kind":"content","content":[{"anchor":"discussion","type":"heading","level":2,"text":"Discussion"},{"style":"note","type":"aside","content":[{"inlineContent":[{"type":"text","text":"Generated from "},{"code":"#\/paths\/masters\/{master_id}\/versions\/GET\/query\/released","type":"codeVoice"},{"type":"text","text":"."}],"type":"paragraph"}],"name":"Remark"}]}],"kind":"symbol","references":{"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/Components/Parameters/Released":{"type":"topic","role":"symbol","kind":"symbol","fragments":[{"text":"typealias","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Released","kind":"identifier"}],"navigatorTitle":[{"text":"Released","kind":"identifier"}],"title":"Components.Parameters.Released","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Parameters\/Released","abstract":[{"type":"text","text":"A filter by release year."}],"url":"\/documentation\/discogsservice\/components\/parameters\/released"},"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/GetMasterVersions/Input":{"type":"topic","abstract":[],"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetMasterVersions\/Input","title":"Operations.GetMasterVersions.Input","navigatorTitle":[{"kind":"identifier","text":"Input"}],"kind":"symbol","url":"\/documentation\/discogsservice\/operations\/getmasterversions\/input","role":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"Input"}]},"doc://DiscogsService/documentation/DiscogsService/Components/Parameters":{"type":"topic","role":"symbol","kind":"symbol","fragments":[{"kind":"keyword","text":"enum"},{"text":" ","kind":"text"},{"text":"Parameters","kind":"identifier"}],"navigatorTitle":[{"text":"Parameters","kind":"identifier"}],"title":"Components.Parameters","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Parameters","url":"\/documentation\/discogsservice\/components\/parameters","abstract":[{"text":"Types generated from the ","type":"text"},{"code":"#\/components\/parameters","type":"codeVoice"},{"text":" section of the OpenAPI document.","type":"text"}]},"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/Components":{"type":"topic","role":"symbol","kind":"symbol","fragments":[{"text":"enum","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Components","kind":"identifier"}],"navigatorTitle":[{"text":"Components","kind":"identifier"}],"title":"Components","url":"\/documentation\/discogsservice\/components","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components","abstract":[{"text":"Types generated from the components section of the OpenAPI document.","type":"text"}]},"doc://DiscogsService/documentation/DiscogsService/Operations/GetMasterVersions/Input/Query-swift.struct/released":{"type":"topic","title":"released","abstract":[{"text":"A filter by release year.","type":"text"}],"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetMasterVersions\/Input\/Query-swift.struct\/released","kind":"symbol","url":"\/documentation\/discogsservice\/operations\/getmasterversions\/input\/query-swift.struct\/released","role":"symbol","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"released"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Components","preciseIdentifier":"s:14DiscogsService10ComponentsO"},{"kind":"text","text":"."},{"kind":"typeIdentifier","text":"Parameters","preciseIdentifier":"s:14DiscogsService10ComponentsO10ParametersO"},{"kind":"text","text":"."},{"kind":"typeIdentifier","text":"Released","preciseIdentifier":"s:14DiscogsService10ComponentsO10ParametersO8Releaseda"},{"text":"?","kind":"text"}]},"doc://DiscogsService/documentation/DiscogsService/Operations/GetMasterVersions/Input/Query-swift.struct":{"type":"topic","title":"Operations.GetMasterVersions.Input.Query","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetMasterVersions\/Input\/Query-swift.struct","abstract":[],"navigatorTitle":[{"text":"Query","kind":"identifier"}],"kind":"symbol","url":"\/documentation\/discogsservice\/operations\/getmasterversions\/input\/query-swift.struct","role":"symbol","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Query","kind":"identifier"}]}}} |