Files
discogs-service/docs/data/documentation/discogsservice/client/deletecollectionfolder(path:headers:).json
T
javier 2a7b9746a7 Implemented the User Collection endpoints (#12)
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>
2025-10-16 14:38:41 +00:00

1 line
15 KiB
JSON

{"sections":[],"metadata":{"roleHeading":"Instance Method","modules":[{"name":"DiscogsService"}],"externalID":"s:14DiscogsService11APIProtocolPAAE22deleteCollectionFolder4path7headersAA10OperationsO06DeleteeF0O6OutputOAJ5InputV4PathV_AN7HeadersVtYaKF::SYNTHESIZED::s:14DiscogsService6ClientV","symbolKind":"method","title":"deleteCollectionFolder(path:headers:)","role":"symbol","extendedModule":"DiscogsService","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"deleteCollectionFolder","kind":"identifier"},{"text":"(","kind":"text"},{"text":"path","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"Operations","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO"},{"text":".","kind":"text"},{"text":"DeleteCollectionFolder","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO22DeleteCollectionFolderO"},{"text":".","kind":"text"},{"text":"Input","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO22DeleteCollectionFolderO5InputV"},{"text":".","kind":"text"},{"text":"Path","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO22DeleteCollectionFolderO5InputV4PathV"},{"text":", ","kind":"text"},{"text":"headers","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"Operations","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO"},{"text":".","kind":"text"},{"text":"DeleteCollectionFolder","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO22DeleteCollectionFolderO"},{"text":".","kind":"text"},{"text":"Input","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO22DeleteCollectionFolderO5InputV"},{"text":".","kind":"text"},{"text":"Headers","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO22DeleteCollectionFolderO5InputV7HeadersV"},{"text":") ","kind":"text"},{"text":"async","kind":"keyword"},{"text":" ","kind":"text"},{"text":"throws","kind":"keyword"},{"text":" -> ","kind":"text"},{"text":"Operations","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO"},{"text":".","kind":"text"},{"text":"DeleteCollectionFolder","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO22DeleteCollectionFolderO"},{"text":".","kind":"text"},{"text":"Output","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO22DeleteCollectionFolderO6OutputO"}]},"abstract":[{"text":"Delete a collection folder from a collection of a user.","type":"text"}],"kind":"symbol","hierarchy":{"paths":[["doc:\/\/DiscogsService\/documentation\/DiscogsService","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Client"]]},"primaryContentSections":[{"kind":"declarations","declarations":[{"platforms":["macOS"],"tokens":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"deleteCollectionFolder"},{"kind":"text","text":"("},{"kind":"externalParam","text":"path"},{"kind":"text","text":": "},{"kind":"typeIdentifier","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations","preciseIdentifier":"s:14DiscogsService10OperationsO","text":"Operations"},{"kind":"text","text":"."},{"kind":"typeIdentifier","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/DeleteCollectionFolder","preciseIdentifier":"s:14DiscogsService10OperationsO22DeleteCollectionFolderO","text":"DeleteCollectionFolder"},{"kind":"text","text":"."},{"kind":"typeIdentifier","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/DeleteCollectionFolder\/Input","preciseIdentifier":"s:14DiscogsService10OperationsO22DeleteCollectionFolderO5InputV","text":"Input"},{"kind":"text","text":"."},{"kind":"typeIdentifier","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/DeleteCollectionFolder\/Input\/Path-swift.struct","preciseIdentifier":"s:14DiscogsService10OperationsO22DeleteCollectionFolderO5InputV4PathV","text":"Path"},{"kind":"text","text":", "},{"kind":"externalParam","text":"headers"},{"kind":"text","text":": "},{"kind":"typeIdentifier","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations","preciseIdentifier":"s:14DiscogsService10OperationsO","text":"Operations"},{"kind":"text","text":"."},{"kind":"typeIdentifier","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/DeleteCollectionFolder","preciseIdentifier":"s:14DiscogsService10OperationsO22DeleteCollectionFolderO","text":"DeleteCollectionFolder"},{"kind":"text","text":"."},{"kind":"typeIdentifier","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/DeleteCollectionFolder\/Input","preciseIdentifier":"s:14DiscogsService10OperationsO22DeleteCollectionFolderO5InputV","text":"Input"},{"kind":"text","text":"."},{"kind":"typeIdentifier","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/DeleteCollectionFolder\/Input\/Headers-swift.struct","preciseIdentifier":"s:14DiscogsService10OperationsO22DeleteCollectionFolderO5InputV7HeadersV","text":"Headers"},{"kind":"text","text":" = .init()) "},{"kind":"keyword","text":"async"},{"kind":"text","text":" "},{"kind":"keyword","text":"throws"},{"kind":"text","text":" -> "},{"kind":"typeIdentifier","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations","preciseIdentifier":"s:14DiscogsService10OperationsO","text":"Operations"},{"kind":"text","text":"."},{"kind":"typeIdentifier","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/DeleteCollectionFolder","preciseIdentifier":"s:14DiscogsService10OperationsO22DeleteCollectionFolderO","text":"DeleteCollectionFolder"},{"kind":"text","text":"."},{"kind":"typeIdentifier","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/DeleteCollectionFolder\/Output","preciseIdentifier":"s:14DiscogsService10OperationsO22DeleteCollectionFolderO6OutputO","text":"Output"}],"languages":["swift"]}]},{"kind":"content","content":[{"anchor":"discussion","level":2,"type":"heading","text":"Discussion"},{"inlineContent":[{"text":"Deletes a collection folder from a collection of a user.","type":"text"}],"type":"paragraph"},{"name":"Important","content":[{"inlineContent":[{"text":"A folder must be empty before it can be deleted.","type":"text"}],"type":"paragraph"}],"type":"aside","style":"important"},{"inlineContent":[{"type":"text","text":"This endpoints requires authentication as the collection owner."}],"type":"paragraph"},{"name":"Remark","content":[{"inlineContent":[{"text":"HTTP ","type":"text"},{"code":"DELETE \/users\/{username}\/collection\/folders\/{folder_id}","type":"codeVoice"},{"text":".","type":"text"}],"type":"paragraph"}],"type":"aside","style":"note"},{"name":"Remark","content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"Generated from "},{"type":"codeVoice","code":"#\/paths\/\/users\/{username}\/collection\/folders\/{folder_id}\/delete(deleteCollectionFolder)"},{"type":"text","text":"."}]}],"type":"aside","style":"note"}]}],"variants":[{"paths":["\/documentation\/discogsservice\/client\/deletecollectionfolder(path:headers:)"],"traits":[{"interfaceLanguage":"swift"}]}],"schemaVersion":{"minor":3,"major":0,"patch":0},"identifier":{"url":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Client\/deleteCollectionFolder(path:headers:)","interfaceLanguage":"swift"},"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/DeleteCollectionFolder":{"url":"\/documentation\/discogsservice\/operations\/deletecollectionfolder","navigatorTitle":[{"text":"DeleteCollectionFolder","kind":"identifier"}],"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/DeleteCollectionFolder","abstract":[{"text":"Delete a collection folder from a collection of a user.","type":"text"}],"kind":"symbol","role":"symbol","fragments":[{"kind":"keyword","text":"enum"},{"kind":"text","text":" "},{"kind":"identifier","text":"DeleteCollectionFolder"}],"type":"topic","title":"Operations.DeleteCollectionFolder"},"doc://DiscogsService/documentation/DiscogsService/Operations/DeleteCollectionFolder/Input":{"fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Input","kind":"identifier"}],"navigatorTitle":[{"text":"Input","kind":"identifier"}],"abstract":[],"kind":"symbol","type":"topic","title":"Operations.DeleteCollectionFolder.Input","url":"\/documentation\/discogsservice\/operations\/deletecollectionfolder\/input","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/DeleteCollectionFolder\/Input","role":"symbol"},"doc://DiscogsService/documentation/DiscogsService/Client/deleteCollectionFolder(path:headers:)":{"role":"symbol","type":"topic","abstract":[{"type":"text","text":"Delete a collection folder from a collection of a user."}],"url":"\/documentation\/discogsservice\/client\/deletecollectionfolder(path:headers:)","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Client\/deleteCollectionFolder(path:headers:)","title":"deleteCollectionFolder(path:headers:)","kind":"symbol","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"deleteCollectionFolder","kind":"identifier"},{"text":"(","kind":"text"},{"text":"path","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"Operations","preciseIdentifier":"s:14DiscogsService10OperationsO","kind":"typeIdentifier"},{"text":".","kind":"text"},{"text":"DeleteCollectionFolder","preciseIdentifier":"s:14DiscogsService10OperationsO22DeleteCollectionFolderO","kind":"typeIdentifier"},{"text":".","kind":"text"},{"text":"Input","preciseIdentifier":"s:14DiscogsService10OperationsO22DeleteCollectionFolderO5InputV","kind":"typeIdentifier"},{"text":".","kind":"text"},{"text":"Path","preciseIdentifier":"s:14DiscogsService10OperationsO22DeleteCollectionFolderO5InputV4PathV","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"headers","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"Operations","preciseIdentifier":"s:14DiscogsService10OperationsO","kind":"typeIdentifier"},{"text":".","kind":"text"},{"text":"DeleteCollectionFolder","preciseIdentifier":"s:14DiscogsService10OperationsO22DeleteCollectionFolderO","kind":"typeIdentifier"},{"text":".","kind":"text"},{"text":"Input","preciseIdentifier":"s:14DiscogsService10OperationsO22DeleteCollectionFolderO5InputV","kind":"typeIdentifier"},{"text":".","kind":"text"},{"text":"Headers","preciseIdentifier":"s:14DiscogsService10OperationsO22DeleteCollectionFolderO5InputV7HeadersV","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":"DeleteCollectionFolder","preciseIdentifier":"s:14DiscogsService10OperationsO22DeleteCollectionFolderO","kind":"typeIdentifier"},{"text":".","kind":"text"},{"text":"Output","preciseIdentifier":"s:14DiscogsService10OperationsO22DeleteCollectionFolderO6OutputO","kind":"typeIdentifier"}]},"doc://DiscogsService/documentation/DiscogsService/Client":{"fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"Client"}],"title":"Client","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":[{"text":"User Collections","type":"text"}],"type":"emphasis"},{"text":" and ","type":"text"},{"inlineContent":[{"text":"Wantlists","type":"text"}],"type":"emphasis"},{"text":", create ","type":"text"},{"inlineContent":[{"text":"Marketplace","type":"text"}],"type":"emphasis"},{"text":" listings, and more.","type":"text"}],"kind":"symbol","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Client","role":"symbol","navigatorTitle":[{"kind":"identifier","text":"Client"}],"type":"topic","url":"\/documentation\/discogsservice\/client"},"doc://DiscogsService/documentation/DiscogsService":{"url":"\/documentation\/discogsservice","abstract":[],"kind":"symbol","type":"topic","title":"DiscogsService","role":"collection","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService"},"doc://DiscogsService/documentation/DiscogsService/Operations/DeleteCollectionFolder/Input/Path-swift.struct":{"role":"symbol","type":"topic","abstract":[],"url":"\/documentation\/discogsservice\/operations\/deletecollectionfolder\/input\/path-swift.struct","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/DeleteCollectionFolder\/Input\/Path-swift.struct","title":"Operations.DeleteCollectionFolder.Input.Path","kind":"symbol","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Path","kind":"identifier"}],"navigatorTitle":[{"text":"Path","kind":"identifier"}]},"doc://DiscogsService/documentation/DiscogsService/Operations/DeleteCollectionFolder/Input/Headers-swift.struct":{"role":"symbol","type":"topic","abstract":[],"url":"\/documentation\/discogsservice\/operations\/deletecollectionfolder\/input\/headers-swift.struct","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/DeleteCollectionFolder\/Input\/Headers-swift.struct","title":"Operations.DeleteCollectionFolder.Input.Headers","kind":"symbol","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Headers","kind":"identifier"}],"navigatorTitle":[{"text":"Headers","kind":"identifier"}]},"doc://DiscogsService/documentation/DiscogsService/Operations/DeleteCollectionFolder/Output":{"navigatorTitle":[{"kind":"identifier","text":"Output"}],"type":"topic","title":"Operations.DeleteCollectionFolder.Output","url":"\/documentation\/discogsservice\/operations\/deletecollectionfolder\/output","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/DeleteCollectionFolder\/Output","fragments":[{"text":"enum","kind":"keyword"},{"kind":"text","text":" "},{"text":"Output","kind":"identifier"}],"kind":"symbol","role":"symbol","abstract":[]}}}