Files
discogs-service/docs/data/documentation/discogsservice/client/deleteinstancefromcollectionfolder(path:headers:).json
T
javier f3d5c0e6ac Implemented the User Wantlist endpoints (#13)
This PR contains the work done to implement the *User Wantlist* endpoints of the *Discogs API* online service in the `Open API` specification document:

* GET `/users/{username}/wants`
* POST `/users/{username}/wants/{release_id}`
* PUT `/users/{username}/wants/{release_id}`
* DELETE `/users/{username}/wants/{release_id}`

Reviewed-on: #13
Co-authored-by: Javier Cicchelli <javier@rock-n-code.com>
Co-committed-by: Javier Cicchelli <javier@rock-n-code.com>
2025-10-16 16:24:46 +00:00

1 line
16 KiB
JSON

{"identifier":{"url":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Client\/deleteInstanceFromCollectionFolder(path:headers:)","interfaceLanguage":"swift"},"kind":"symbol","sections":[],"hierarchy":{"paths":[["doc:\/\/DiscogsService\/documentation\/DiscogsService","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Client"]]},"schemaVersion":{"minor":3,"major":0,"patch":0},"abstract":[{"type":"text","text":"Delete a specified release instance in a specified collection folder of a user."}],"primaryContentSections":[{"kind":"declarations","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"},{"preciseIdentifier":"s:14DiscogsService10OperationsO","text":"Operations","kind":"typeIdentifier","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations"},{"text":".","kind":"text"},{"preciseIdentifier":"s:14DiscogsService10OperationsO34DeleteInstanceFromCollectionFolderO","text":"DeleteInstanceFromCollectionFolder","kind":"typeIdentifier","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/DeleteInstanceFromCollectionFolder"},{"text":".","kind":"text"},{"preciseIdentifier":"s:14DiscogsService10OperationsO34DeleteInstanceFromCollectionFolderO5InputV","text":"Input","kind":"typeIdentifier","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/DeleteInstanceFromCollectionFolder\/Input"},{"text":".","kind":"text"},{"preciseIdentifier":"s:14DiscogsService10OperationsO34DeleteInstanceFromCollectionFolderO5InputV4PathV","text":"Path","kind":"typeIdentifier","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/DeleteInstanceFromCollectionFolder\/Input\/Path-swift.struct"},{"text":", ","kind":"text"},{"text":"headers","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:14DiscogsService10OperationsO","text":"Operations","kind":"typeIdentifier","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations"},{"text":".","kind":"text"},{"preciseIdentifier":"s:14DiscogsService10OperationsO34DeleteInstanceFromCollectionFolderO","text":"DeleteInstanceFromCollectionFolder","kind":"typeIdentifier","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/DeleteInstanceFromCollectionFolder"},{"text":".","kind":"text"},{"preciseIdentifier":"s:14DiscogsService10OperationsO34DeleteInstanceFromCollectionFolderO5InputV","text":"Input","kind":"typeIdentifier","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/DeleteInstanceFromCollectionFolder\/Input"},{"text":".","kind":"text"},{"preciseIdentifier":"s:14DiscogsService10OperationsO34DeleteInstanceFromCollectionFolderO5InputV7HeadersV","text":"Headers","kind":"typeIdentifier","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"},{"preciseIdentifier":"s:14DiscogsService10OperationsO","text":"Operations","kind":"typeIdentifier","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations"},{"text":".","kind":"text"},{"preciseIdentifier":"s:14DiscogsService10OperationsO34DeleteInstanceFromCollectionFolderO","text":"DeleteInstanceFromCollectionFolder","kind":"typeIdentifier","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/DeleteInstanceFromCollectionFolder"},{"text":".","kind":"text"},{"preciseIdentifier":"s:14DiscogsService10OperationsO34DeleteInstanceFromCollectionFolderO6OutputO","text":"Output","kind":"typeIdentifier","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/DeleteInstanceFromCollectionFolder\/Output"}]}]},{"content":[{"level":2,"anchor":"discussion","type":"heading","text":"Discussion"},{"inlineContent":[{"text":"Removes an instance of a release from a collection folder of a user.","type":"text"}],"type":"paragraph"},{"content":[{"inlineContent":[{"type":"text","text":"To move the release to the "},{"type":"emphasis","inlineContent":[{"type":"text","text":"Uncategorized"}]},{"type":"text","text":" folder instead, use the "},{"type":"codeVoice","code":"POST"},{"type":"text","text":" method."}],"type":"paragraph"}],"style":"important","type":"aside","name":"Important"},{"inlineContent":[{"text":"This endpoint requires authentication as the collection owner.","type":"text"}],"type":"paragraph"},{"content":[{"inlineContent":[{"type":"text","text":"HTTP "},{"type":"codeVoice","code":"DELETE \/users\/{username}\/collection\/folders\/{folder_id}\/releases\/{release_id}\/instances\/{instance_id}"},{"type":"text","text":"."}],"type":"paragraph"}],"style":"note","type":"aside","name":"Remark"},{"content":[{"inlineContent":[{"type":"text","text":"Generated from "},{"type":"codeVoice","code":"#\/paths\/\/users\/{username}\/collection\/folders\/{folder_id}\/releases\/{release_id}\/instances\/{instance_id}\/delete(deleteInstanceFromCollectionFolder)"},{"type":"text","text":"."}],"type":"paragraph"}],"style":"note","type":"aside","name":"Remark"}],"kind":"content"}],"metadata":{"externalID":"s:14DiscogsService11APIProtocolPAAE34deleteInstanceFromCollectionFolder4path7headersAA10OperationsO06DeleteefgH0O6OutputOAJ5InputV4PathV_AN7HeadersVtYaKF::SYNTHESIZED::s:14DiscogsService6ClientV","role":"symbol","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"deleteInstanceFromCollectionFolder"},{"kind":"text","text":"("},{"kind":"externalParam","text":"path"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO","text":"Operations"},{"kind":"text","text":"."},{"kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO34DeleteInstanceFromCollectionFolderO","text":"DeleteInstanceFromCollectionFolder"},{"kind":"text","text":"."},{"kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO34DeleteInstanceFromCollectionFolderO5InputV","text":"Input"},{"kind":"text","text":"."},{"kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO34DeleteInstanceFromCollectionFolderO5InputV4PathV","text":"Path"},{"kind":"text","text":", "},{"kind":"externalParam","text":"headers"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO","text":"Operations"},{"kind":"text","text":"."},{"kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO34DeleteInstanceFromCollectionFolderO","text":"DeleteInstanceFromCollectionFolder"},{"kind":"text","text":"."},{"kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO34DeleteInstanceFromCollectionFolderO5InputV","text":"Input"},{"kind":"text","text":"."},{"kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO34DeleteInstanceFromCollectionFolderO5InputV7HeadersV","text":"Headers"},{"kind":"text","text":") "},{"kind":"keyword","text":"async"},{"kind":"text","text":" "},{"kind":"keyword","text":"throws"},{"kind":"text","text":" -> "},{"kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO","text":"Operations"},{"kind":"text","text":"."},{"kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO34DeleteInstanceFromCollectionFolderO","text":"DeleteInstanceFromCollectionFolder"},{"kind":"text","text":"."},{"kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO34DeleteInstanceFromCollectionFolderO6OutputO","text":"Output"}],"modules":[{"name":"DiscogsService"}],"symbolKind":"method","title":"deleteInstanceFromCollectionFolder(path:headers:)","extendedModule":"DiscogsService","roleHeading":"Instance Method"},"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/discogsservice\/client\/deleteinstancefromcollectionfolder(path:headers:)"]}],"references":{"doc://DiscogsService/documentation/DiscogsService/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"}],"kind":"symbol","role":"symbol","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations","url":"\/documentation\/discogsservice\/operations","fragments":[{"text":"enum","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Operations","kind":"identifier"}],"navigatorTitle":[{"kind":"identifier","text":"Operations"}],"type":"topic","title":"Operations"},"doc://DiscogsService/documentation/DiscogsService":{"title":"DiscogsService","type":"topic","url":"\/documentation\/discogsservice","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService","abstract":[],"kind":"symbol","role":"collection"},"doc://DiscogsService/documentation/DiscogsService/Client":{"role":"symbol","navigatorTitle":[{"kind":"identifier","text":"Client"}],"fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"Client"}],"abstract":[{"type":"text","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":"emphasis","inlineContent":[{"type":"text","text":"Artists"}]},{"type":"text","text":", "},{"type":"emphasis","inlineContent":[{"type":"text","text":"Releases"}]},{"type":"text","text":", and "},{"type":"emphasis","inlineContent":[{"type":"text","text":"Labels"}]},{"type":"text","text":". Your application can also manage "},{"type":"emphasis","inlineContent":[{"type":"text","text":"User Collections"}]},{"type":"text","text":" and "},{"type":"emphasis","inlineContent":[{"type":"text","text":"Wantlists"}]},{"type":"text","text":", create "},{"type":"emphasis","inlineContent":[{"type":"text","text":"Marketplace"}]},{"type":"text","text":" listings, and more."}],"url":"\/documentation\/discogsservice\/client","title":"Client","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Client","type":"topic","kind":"symbol"},"doc://DiscogsService/documentation/DiscogsService/Operations/DeleteInstanceFromCollectionFolder/Input/Path-swift.struct":{"navigatorTitle":[{"text":"Path","kind":"identifier"}],"url":"\/documentation\/discogsservice\/operations\/deleteinstancefromcollectionfolder\/input\/path-swift.struct","title":"Operations.DeleteInstanceFromCollectionFolder.Input.Path","abstract":[],"type":"topic","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Path","kind":"identifier"}],"role":"symbol","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/DeleteInstanceFromCollectionFolder\/Input\/Path-swift.struct","kind":"symbol"},"doc://DiscogsService/documentation/DiscogsService/Operations/DeleteInstanceFromCollectionFolder":{"title":"Operations.DeleteInstanceFromCollectionFolder","navigatorTitle":[{"text":"DeleteInstanceFromCollectionFolder","kind":"identifier"}],"type":"topic","kind":"symbol","role":"symbol","abstract":[{"text":"Delete a specified release instance in a specified collection folder of a user.","type":"text"}],"fragments":[{"kind":"keyword","text":"enum"},{"kind":"text","text":" "},{"kind":"identifier","text":"DeleteInstanceFromCollectionFolder"}],"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/DeleteInstanceFromCollectionFolder","url":"\/documentation\/discogsservice\/operations\/deleteinstancefromcollectionfolder"},"doc://DiscogsService/documentation/DiscogsService/Client/deleteInstanceFromCollectionFolder(path:headers:)":{"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Client\/deleteInstanceFromCollectionFolder(path:headers:)","kind":"symbol","role":"symbol","abstract":[{"text":"Delete a specified release instance in a specified collection folder of a user.","type":"text"}],"type":"topic","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"},{"kind":"typeIdentifier","text":"DeleteInstanceFromCollectionFolder","preciseIdentifier":"s:14DiscogsService10OperationsO34DeleteInstanceFromCollectionFolderO"},{"kind":"text","text":"."},{"text":"Input","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO34DeleteInstanceFromCollectionFolderO5InputV"},{"text":".","kind":"text"},{"kind":"typeIdentifier","text":"Path","preciseIdentifier":"s:14DiscogsService10OperationsO34DeleteInstanceFromCollectionFolderO5InputV4PathV"},{"text":", ","kind":"text"},{"kind":"externalParam","text":"headers"},{"kind":"text","text":": "},{"text":"Operations","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO"},{"kind":"text","text":"."},{"text":"DeleteInstanceFromCollectionFolder","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO34DeleteInstanceFromCollectionFolderO"},{"text":".","kind":"text"},{"text":"Input","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO34DeleteInstanceFromCollectionFolderO5InputV"},{"text":".","kind":"text"},{"text":"Headers","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO34DeleteInstanceFromCollectionFolderO5InputV7HeadersV"},{"text":") ","kind":"text"},{"text":"async","kind":"keyword"},{"text":" ","kind":"text"},{"text":"throws","kind":"keyword"},{"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:14DiscogsService10OperationsO34DeleteInstanceFromCollectionFolderO6OutputO","text":"Output","kind":"typeIdentifier"}],"title":"deleteInstanceFromCollectionFolder(path:headers:)","url":"\/documentation\/discogsservice\/client\/deleteinstancefromcollectionfolder(path:headers:)"},"doc://DiscogsService/documentation/DiscogsService/Operations/DeleteInstanceFromCollectionFolder/Input/Headers-swift.struct":{"title":"Operations.DeleteInstanceFromCollectionFolder.Input.Headers","navigatorTitle":[{"text":"Headers","kind":"identifier"}],"type":"topic","kind":"symbol","role":"symbol","abstract":[],"fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Headers","kind":"identifier"}],"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/DeleteInstanceFromCollectionFolder\/Input\/Headers-swift.struct","url":"\/documentation\/discogsservice\/operations\/deleteinstancefromcollectionfolder\/input\/headers-swift.struct"},"doc://DiscogsService/documentation/DiscogsService/Operations/DeleteInstanceFromCollectionFolder/Output":{"abstract":[],"role":"symbol","url":"\/documentation\/discogsservice\/operations\/deleteinstancefromcollectionfolder\/output","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/DeleteInstanceFromCollectionFolder\/Output","type":"topic","fragments":[{"kind":"keyword","text":"enum"},{"text":" ","kind":"text"},{"kind":"identifier","text":"Output"}],"navigatorTitle":[{"text":"Output","kind":"identifier"}],"title":"Operations.DeleteInstanceFromCollectionFolder.Output","kind":"symbol"},"doc://DiscogsService/documentation/DiscogsService/Operations/DeleteInstanceFromCollectionFolder/Input":{"navigatorTitle":[{"text":"Input","kind":"identifier"}],"url":"\/documentation\/discogsservice\/operations\/deleteinstancefromcollectionfolder\/input","title":"Operations.DeleteInstanceFromCollectionFolder.Input","abstract":[],"type":"topic","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Input","kind":"identifier"}],"role":"symbol","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/DeleteInstanceFromCollectionFolder\/Input","kind":"symbol"}}}