2a7b9746a7
This PR contains the work done to implement the *User Collection* endpoints of the Discogs API into the `OpenAPI` specification document:
* GET `/users/{username}/collection/folders`
* POST `/users/{username}/collection/folders`
* GET `/users/{username}/collection/folders/{folder_id}`
* POST `/users/{username}/collection/folders/{folder_id}`
* DELETE `/users/{username}/collection/folders/{folder_id}`
* GET `/users/{username}/collection/releases/{release_id}`
* GET `/users/{username}/collection/folders/{folder_id}/releases`
* POST `/users/{username}/collection/folders/{folder_id}/releases/{release_id}`
* POST `/users/{username}/collection/folders/{folder_id}/releases/{release_id}/instances/{instance_id}`
* DELETE `/users/{username}/collection/folders/{folder_id}/releases/{release_id}/instances/{instance_id}`
* GET `/users/{username}/collection/fields`
* POST `/users/{username}/collection/folders/{folder_id}/releases/{release_id}/instances/{instance_id}/fields/{field_id}`
* GET `/users/{username}/collection/value`
Reviewed-on: #12
Co-authored-by: Javier Cicchelli <javier@rock-n-code.com>
Co-committed-by: Javier Cicchelli <javier@rock-n-code.com>
1 line
7.6 KiB
JSON
1 line
7.6 KiB
JSON
{"metadata":{"title":"ok","roleHeading":"Instance Property","fragments":[{"kind":"keyword","text":"var"},{"text":" ","kind":"text"},{"kind":"identifier","text":"ok"},{"kind":"text","text":": "},{"preciseIdentifier":"s:14DiscogsService10OperationsO","kind":"typeIdentifier","text":"Operations"},{"kind":"text","text":"."},{"preciseIdentifier":"s:14DiscogsService10OperationsO17GetMasterVersionsO","kind":"typeIdentifier","text":"GetMasterVersions"},{"kind":"text","text":"."},{"text":"Output","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO17GetMasterVersionsO6OutputO"},{"kind":"text","text":"."},{"text":"Ok","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO17GetMasterVersionsO6OutputO2OkV"}],"role":"symbol","externalID":"s:14DiscogsService10OperationsO17GetMasterVersionsO6OutputO2okAG2OkVvp","modules":[{"name":"DiscogsService"}],"symbolKind":"property"},"variants":[{"paths":["\/documentation\/discogsservice\/operations\/getmasterversions\/output\/ok-swift.property"],"traits":[{"interfaceLanguage":"swift"}]}],"primaryContentSections":[{"declarations":[{"tokens":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"ok","kind":"identifier"},{"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"},{"kind":"text","text":"."},{"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetMasterVersions\/Output\/Ok-swift.struct","preciseIdentifier":"s:14DiscogsService10OperationsO17GetMasterVersionsO6OutputO2OkV","kind":"typeIdentifier","text":"Ok"},{"text":" { ","kind":"text"},{"text":"get","kind":"keyword"},{"text":" ","kind":"text"},{"text":"throws","kind":"keyword"},{"text":" }","kind":"text"}],"platforms":["macOS"],"languages":["swift"]}],"kind":"declarations"},{"content":[{"anchor":"discussion","type":"heading","level":2,"text":"Discussion"},{"type":"aside","name":"Throws","style":"note","content":[{"inlineContent":[{"type":"text","text":"An error if "},{"type":"codeVoice","code":"self"},{"text":" is not ","type":"text"},{"code":".ok","type":"codeVoice"},{"type":"text","text":"."}],"type":"paragraph"}]},{"name":"See Also","content":[{"type":"paragraph","inlineContent":[{"text":"","type":"text"},{"type":"codeVoice","code":".ok"},{"text":".","type":"text"}]}],"type":"aside","style":"note"}],"kind":"content"}],"hierarchy":{"paths":[["doc:\/\/DiscogsService\/documentation\/DiscogsService","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetMasterVersions","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetMasterVersions\/Output"]]},"schemaVersion":{"minor":3,"major":0,"patch":0},"sections":[],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetMasterVersions\/Output\/ok-swift.property"},"kind":"symbol","abstract":[{"type":"text","text":"The associated value of the enum case if "},{"type":"codeVoice","code":"self"},{"text":" is ","type":"text"},{"type":"codeVoice","code":".ok"},{"text":".","type":"text"}],"references":{"doc://DiscogsService/documentation/DiscogsService/Operations":{"abstract":[{"type":"text","text":"API operations, with input and output types, generated from "},{"code":"#\/paths","type":"codeVoice"},{"text":" in the OpenAPI document.","type":"text"}],"title":"Operations","fragments":[{"text":"enum","kind":"keyword"},{"kind":"text","text":" "},{"text":"Operations","kind":"identifier"}],"role":"symbol","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations","url":"\/documentation\/discogsservice\/operations","navigatorTitle":[{"text":"Operations","kind":"identifier"}],"type":"topic","kind":"symbol"},"doc://DiscogsService/documentation/DiscogsService/Operations/GetMasterVersions/Output":{"navigatorTitle":[{"kind":"identifier","text":"Output"}],"type":"topic","title":"Operations.GetMasterVersions.Output","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetMasterVersions\/Output","url":"\/documentation\/discogsservice\/operations\/getmasterversions\/output","fragments":[{"kind":"keyword","text":"enum"},{"kind":"text","text":" "},{"kind":"identifier","text":"Output"}],"kind":"symbol","role":"symbol","abstract":[]},"doc://DiscogsService/documentation/DiscogsService/Operations/GetMasterVersions":{"fragments":[{"kind":"keyword","text":"enum"},{"kind":"text","text":" "},{"kind":"identifier","text":"GetMasterVersions"}],"navigatorTitle":[{"kind":"identifier","text":"GetMasterVersions"}],"abstract":[{"text":"Get information about the versions of a master release.","type":"text"}],"kind":"symbol","type":"topic","title":"Operations.GetMasterVersions","url":"\/documentation\/discogsservice\/operations\/getmasterversions","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetMasterVersions","role":"symbol"},"doc://DiscogsService/documentation/DiscogsService/Operations/GetMasterVersions/Output/Ok-swift.struct":{"fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"Ok"}],"navigatorTitle":[{"kind":"identifier","text":"Ok"}],"abstract":[],"kind":"symbol","type":"topic","title":"Operations.GetMasterVersions.Output.Ok","url":"\/documentation\/discogsservice\/operations\/getmasterversions\/output\/ok-swift.struct","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetMasterVersions\/Output\/Ok-swift.struct","role":"symbol"},"doc://DiscogsService/documentation/DiscogsService/Operations/GetMasterVersions/Output/ok-swift.property":{"url":"\/documentation\/discogsservice\/operations\/getmasterversions\/output\/ok-swift.property","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetMasterVersions\/Output\/ok-swift.property","abstract":[{"type":"text","text":"The associated value of the enum case if "},{"code":"self","type":"codeVoice"},{"type":"text","text":" is "},{"code":".ok","type":"codeVoice"},{"type":"text","text":"."}],"kind":"symbol","role":"symbol","fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"ok","kind":"identifier"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:14DiscogsService10OperationsO","text":"Operations","kind":"typeIdentifier"},{"text":".","kind":"text"},{"preciseIdentifier":"s:14DiscogsService10OperationsO17GetMasterVersionsO","text":"GetMasterVersions","kind":"typeIdentifier"},{"text":".","kind":"text"},{"preciseIdentifier":"s:14DiscogsService10OperationsO17GetMasterVersionsO6OutputO","text":"Output","kind":"typeIdentifier"},{"text":".","kind":"text"},{"preciseIdentifier":"s:14DiscogsService10OperationsO17GetMasterVersionsO6OutputO2OkV","text":"Ok","kind":"typeIdentifier"}],"title":"ok","type":"topic"},"doc://DiscogsService/documentation/DiscogsService":{"url":"\/documentation\/discogsservice","abstract":[],"kind":"symbol","type":"topic","title":"DiscogsService","role":"collection","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService"}}} |