Files
discogs-service/docs/data/documentation/discogsservice/client/deleteinstancefromcollectionfolder(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
16 KiB
JSON

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