63118db805
This PR contains the work done to implement the *User Lists* endpoints of the *Discogs API* service in the `Open API` specification document:
* GET `/users/{username}/lists`
* GET `/lists/{list_id}`
Reviewed-on: #14
Co-authored-by: Javier Cicchelli <javier@rock-n-code.com>
Co-committed-by: Javier Cicchelli <javier@rock-n-code.com>
1 line
16 KiB
JSON
1 line
16 KiB
JSON
{"primaryContentSections":[{"declarations":[{"languages":["swift"],"platforms":["macOS"],"tokens":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"deleteInstanceFromCollectionFolder","kind":"identifier"},{"text":"(","kind":"text"},{"text":"path","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"Operations","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations"},{"text":".","kind":"text"},{"text":"DeleteInstanceFromCollectionFolder","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO34DeleteInstanceFromCollectionFolderO","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/DeleteInstanceFromCollectionFolder"},{"text":".","kind":"text"},{"text":"Input","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO34DeleteInstanceFromCollectionFolderO5InputV","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/DeleteInstanceFromCollectionFolder\/Input"},{"text":".","kind":"text"},{"text":"Path","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO34DeleteInstanceFromCollectionFolderO5InputV4PathV","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/DeleteInstanceFromCollectionFolder\/Input\/Path-swift.struct"},{"text":", ","kind":"text"},{"text":"headers","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"Operations","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations"},{"text":".","kind":"text"},{"text":"DeleteInstanceFromCollectionFolder","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO34DeleteInstanceFromCollectionFolderO","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/DeleteInstanceFromCollectionFolder"},{"text":".","kind":"text"},{"text":"Input","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO34DeleteInstanceFromCollectionFolderO5InputV","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/DeleteInstanceFromCollectionFolder\/Input"},{"text":".","kind":"text"},{"text":"Headers","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO34DeleteInstanceFromCollectionFolderO5InputV7HeadersV","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/DeleteInstanceFromCollectionFolder\/Input\/Headers-swift.struct"},{"text":" = .init()) ","kind":"text"},{"text":"async","kind":"keyword"},{"text":" ","kind":"text"},{"text":"throws","kind":"keyword"},{"text":" -> ","kind":"text"},{"text":"Operations","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations"},{"text":".","kind":"text"},{"text":"DeleteInstanceFromCollectionFolder","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO34DeleteInstanceFromCollectionFolderO","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/DeleteInstanceFromCollectionFolder"},{"text":".","kind":"text"},{"text":"Output","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO34DeleteInstanceFromCollectionFolderO6OutputO","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/DeleteInstanceFromCollectionFolder\/Output"}]}],"kind":"declarations"},{"content":[{"text":"Discussion","anchor":"discussion","type":"heading","level":2},{"inlineContent":[{"text":"Removes an instance of a release from a collection folder of a user.","type":"text"}],"type":"paragraph"},{"style":"important","content":[{"type":"paragraph","inlineContent":[{"text":"To move the release to the ","type":"text"},{"inlineContent":[{"type":"text","text":"Uncategorized"}],"type":"emphasis"},{"text":" folder instead, use the ","type":"text"},{"code":"POST","type":"codeVoice"},{"text":" method.","type":"text"}]}],"type":"aside","name":"Important"},{"inlineContent":[{"text":"This endpoint requires authentication as the collection owner.","type":"text"}],"type":"paragraph"},{"style":"note","content":[{"type":"paragraph","inlineContent":[{"text":"HTTP ","type":"text"},{"code":"DELETE \/users\/{username}\/collection\/folders\/{folder_id}\/releases\/{release_id}\/instances\/{instance_id}","type":"codeVoice"},{"text":".","type":"text"}]}],"type":"aside","name":"Remark"},{"style":"note","content":[{"type":"paragraph","inlineContent":[{"text":"Generated from ","type":"text"},{"code":"#\/paths\/\/users\/{username}\/collection\/folders\/{folder_id}\/releases\/{release_id}\/instances\/{instance_id}\/delete(deleteInstanceFromCollectionFolder)","type":"codeVoice"},{"text":".","type":"text"}]}],"type":"aside","name":"Remark"}],"kind":"content"}],"metadata":{"roleHeading":"Instance Method","extendedModule":"DiscogsService","symbolKind":"method","title":"deleteInstanceFromCollectionFolder(path:headers:)","modules":[{"name":"DiscogsService"}],"role":"symbol","externalID":"s:14DiscogsService11APIProtocolPAAE34deleteInstanceFromCollectionFolder4path7headersAA10OperationsO06DeleteefgH0O6OutputOAJ5InputV4PathV_AN7HeadersVtYaKF::SYNTHESIZED::s:14DiscogsService6ClientV","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"deleteInstanceFromCollectionFolder","kind":"identifier"},{"text":"(","kind":"text"},{"text":"path","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"Operations","preciseIdentifier":"s:14DiscogsService10OperationsO","kind":"typeIdentifier"},{"text":".","kind":"text"},{"text":"DeleteInstanceFromCollectionFolder","preciseIdentifier":"s:14DiscogsService10OperationsO34DeleteInstanceFromCollectionFolderO","kind":"typeIdentifier"},{"text":".","kind":"text"},{"text":"Input","preciseIdentifier":"s:14DiscogsService10OperationsO34DeleteInstanceFromCollectionFolderO5InputV","kind":"typeIdentifier"},{"text":".","kind":"text"},{"text":"Path","preciseIdentifier":"s:14DiscogsService10OperationsO34DeleteInstanceFromCollectionFolderO5InputV4PathV","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"headers","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"Operations","preciseIdentifier":"s:14DiscogsService10OperationsO","kind":"typeIdentifier"},{"text":".","kind":"text"},{"text":"DeleteInstanceFromCollectionFolder","preciseIdentifier":"s:14DiscogsService10OperationsO34DeleteInstanceFromCollectionFolderO","kind":"typeIdentifier"},{"text":".","kind":"text"},{"text":"Input","preciseIdentifier":"s:14DiscogsService10OperationsO34DeleteInstanceFromCollectionFolderO5InputV","kind":"typeIdentifier"},{"text":".","kind":"text"},{"text":"Headers","preciseIdentifier":"s:14DiscogsService10OperationsO34DeleteInstanceFromCollectionFolderO5InputV7HeadersV","kind":"typeIdentifier"},{"text":") ","kind":"text"},{"text":"async","kind":"keyword"},{"text":" ","kind":"text"},{"text":"throws","kind":"keyword"},{"text":" -> ","kind":"text"},{"text":"Operations","preciseIdentifier":"s:14DiscogsService10OperationsO","kind":"typeIdentifier"},{"text":".","kind":"text"},{"text":"DeleteInstanceFromCollectionFolder","preciseIdentifier":"s:14DiscogsService10OperationsO34DeleteInstanceFromCollectionFolderO","kind":"typeIdentifier"},{"text":".","kind":"text"},{"text":"Output","preciseIdentifier":"s:14DiscogsService10OperationsO34DeleteInstanceFromCollectionFolderO6OutputO","kind":"typeIdentifier"}]},"sections":[],"hierarchy":{"paths":[["doc:\/\/DiscogsService\/documentation\/DiscogsService","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Client"]]},"schemaVersion":{"patch":0,"major":0,"minor":3},"abstract":[{"text":"Delete a specified release instance in a specified collection folder of a user.","type":"text"}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/discogsservice\/client\/deleteinstancefromcollectionfolder(path:headers:)"]}],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Client\/deleteInstanceFromCollectionFolder(path:headers:)"},"kind":"symbol","references":{"doc://DiscogsService/documentation/DiscogsService":{"url":"\/documentation\/discogsservice","role":"collection","abstract":[],"title":"DiscogsService","type":"topic","kind":"symbol","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService"},"doc://DiscogsService/documentation/DiscogsService/Client/deleteInstanceFromCollectionFolder(path:headers:)":{"type":"topic","url":"\/documentation\/discogsservice\/client\/deleteinstancefromcollectionfolder(path:headers:)","abstract":[{"type":"text","text":"Delete a specified release instance in a specified collection folder of a user."}],"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Client\/deleteInstanceFromCollectionFolder(path:headers:)","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"deleteInstanceFromCollectionFolder","kind":"identifier"},{"text":"(","kind":"text"},{"text":"path","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:14DiscogsService10OperationsO","text":"Operations","kind":"typeIdentifier"},{"text":".","kind":"text"},{"preciseIdentifier":"s:14DiscogsService10OperationsO34DeleteInstanceFromCollectionFolderO","text":"DeleteInstanceFromCollectionFolder","kind":"typeIdentifier"},{"text":".","kind":"text"},{"preciseIdentifier":"s:14DiscogsService10OperationsO34DeleteInstanceFromCollectionFolderO5InputV","text":"Input","kind":"typeIdentifier"},{"text":".","kind":"text"},{"preciseIdentifier":"s:14DiscogsService10OperationsO34DeleteInstanceFromCollectionFolderO5InputV4PathV","text":"Path","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"headers","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:14DiscogsService10OperationsO","text":"Operations","kind":"typeIdentifier"},{"text":".","kind":"text"},{"preciseIdentifier":"s:14DiscogsService10OperationsO34DeleteInstanceFromCollectionFolderO","text":"DeleteInstanceFromCollectionFolder","kind":"typeIdentifier"},{"text":".","kind":"text"},{"preciseIdentifier":"s:14DiscogsService10OperationsO34DeleteInstanceFromCollectionFolderO5InputV","text":"Input","kind":"typeIdentifier"},{"text":".","kind":"text"},{"preciseIdentifier":"s:14DiscogsService10OperationsO34DeleteInstanceFromCollectionFolderO5InputV7HeadersV","text":"Headers","kind":"typeIdentifier"},{"text":") ","kind":"text"},{"text":"async","kind":"keyword"},{"text":" ","kind":"text"},{"text":"throws","kind":"keyword"},{"text":" -> ","kind":"text"},{"preciseIdentifier":"s:14DiscogsService10OperationsO","text":"Operations","kind":"typeIdentifier"},{"kind":"text","text":"."},{"kind":"typeIdentifier","text":"DeleteInstanceFromCollectionFolder","preciseIdentifier":"s:14DiscogsService10OperationsO34DeleteInstanceFromCollectionFolderO"},{"kind":"text","text":"."},{"kind":"typeIdentifier","text":"Output","preciseIdentifier":"s:14DiscogsService10OperationsO34DeleteInstanceFromCollectionFolderO6OutputO"}],"role":"symbol","kind":"symbol","title":"deleteInstanceFromCollectionFolder(path:headers:)"},"doc://DiscogsService/documentation/DiscogsService/Client":{"type":"topic","navigatorTitle":[{"text":"Client","kind":"identifier"}],"title":"Client","kind":"symbol","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Client","kind":"identifier"}],"abstract":[{"text":"The Discogs API v2.0 is a RESTful interface to Discogs data. You can access JSON-formatted information about Database objects such as ","type":"text"},{"inlineContent":[{"text":"Artists","type":"text"}],"type":"emphasis"},{"text":", ","type":"text"},{"inlineContent":[{"text":"Releases","type":"text"}],"type":"emphasis"},{"text":", and ","type":"text"},{"inlineContent":[{"text":"Labels","type":"text"}],"type":"emphasis"},{"text":". Your application can also manage ","type":"text"},{"inlineContent":[{"type":"text","text":"User Collections"}],"type":"emphasis"},{"text":" and ","type":"text"},{"inlineContent":[{"text":"Wantlists","type":"text"}],"type":"emphasis"},{"type":"text","text":", create "},{"type":"emphasis","inlineContent":[{"text":"Marketplace","type":"text"}]},{"type":"text","text":" listings, and more."}],"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Client","role":"symbol","url":"\/documentation\/discogsservice\/client"},"doc://DiscogsService/documentation/DiscogsService/Operations/DeleteInstanceFromCollectionFolder/Input":{"url":"\/documentation\/discogsservice\/operations\/deleteinstancefromcollectionfolder\/input","abstract":[],"title":"Operations.DeleteInstanceFromCollectionFolder.Input","type":"topic","role":"symbol","navigatorTitle":[{"text":"Input","kind":"identifier"}],"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/DeleteInstanceFromCollectionFolder\/Input","kind":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"text":" ","kind":"text"},{"text":"Input","kind":"identifier"}]},"doc://DiscogsService/documentation/DiscogsService/Operations/DeleteInstanceFromCollectionFolder/Input/Headers-swift.struct":{"kind":"symbol","navigatorTitle":[{"text":"Headers","kind":"identifier"}],"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/DeleteInstanceFromCollectionFolder\/Input\/Headers-swift.struct","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Headers","kind":"identifier"}],"role":"symbol","type":"topic","title":"Operations.DeleteInstanceFromCollectionFolder.Input.Headers","abstract":[],"url":"\/documentation\/discogsservice\/operations\/deleteinstancefromcollectionfolder\/input\/headers-swift.struct"},"doc://DiscogsService/documentation/DiscogsService/Operations/DeleteInstanceFromCollectionFolder/Input/Path-swift.struct":{"url":"\/documentation\/discogsservice\/operations\/deleteinstancefromcollectionfolder\/input\/path-swift.struct","kind":"symbol","abstract":[],"type":"topic","role":"symbol","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"Path"}],"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/DeleteInstanceFromCollectionFolder\/Input\/Path-swift.struct","navigatorTitle":[{"text":"Path","kind":"identifier"}],"title":"Operations.DeleteInstanceFromCollectionFolder.Input.Path"},"doc://DiscogsService/documentation/DiscogsService/Operations/DeleteInstanceFromCollectionFolder/Output":{"kind":"symbol","navigatorTitle":[{"kind":"identifier","text":"Output"}],"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/DeleteInstanceFromCollectionFolder\/Output","fragments":[{"kind":"keyword","text":"enum"},{"kind":"text","text":" "},{"kind":"identifier","text":"Output"}],"role":"symbol","type":"topic","title":"Operations.DeleteInstanceFromCollectionFolder.Output","abstract":[],"url":"\/documentation\/discogsservice\/operations\/deleteinstancefromcollectionfolder\/output"},"doc://DiscogsService/documentation/DiscogsService/Operations":{"kind":"symbol","navigatorTitle":[{"text":"Operations","kind":"identifier"}],"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations","fragments":[{"text":"enum","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Operations","kind":"identifier"}],"role":"symbol","type":"topic","title":"Operations","abstract":[{"type":"text","text":"API operations, with input and output types, generated from "},{"type":"codeVoice","code":"#\/paths"},{"text":" in the OpenAPI document.","type":"text"}],"url":"\/documentation\/discogsservice\/operations"},"doc://DiscogsService/documentation/DiscogsService/Operations/DeleteInstanceFromCollectionFolder":{"kind":"symbol","navigatorTitle":[{"kind":"identifier","text":"DeleteInstanceFromCollectionFolder"}],"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/DeleteInstanceFromCollectionFolder","fragments":[{"kind":"keyword","text":"enum"},{"kind":"text","text":" "},{"kind":"identifier","text":"DeleteInstanceFromCollectionFolder"}],"role":"symbol","type":"topic","title":"Operations.DeleteInstanceFromCollectionFolder","abstract":[{"type":"text","text":"Delete a specified release instance in a specified collection folder of a user."}],"url":"\/documentation\/discogsservice\/operations\/deleteinstancefromcollectionfolder"}}} |