Files
discogs-service/docs/data/documentation/discogsservice/client/deletecollectionfolder(path:headers:).json
javier eaee2b84f0 Documentation update (#17)
This PR contains the work done to update the overall documentation of the package.

Reviewed-on: #17
Co-authored-by: Javier Cicchelli <javier@rock-n-code.com>
Co-committed-by: Javier Cicchelli <javier@rock-n-code.com>
2026-03-24 01:54:43 +00:00

1 line
15 KiB
JSON

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