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