63118db805
This PR contains the work done to implement the *User Lists* endpoints of the *Discogs API* service in the `Open API` specification document:
* GET `/users/{username}/lists`
* GET `/lists/{list_id}`
Reviewed-on: #14
Co-authored-by: Javier Cicchelli <javier@rock-n-code.com>
Co-committed-by: Javier Cicchelli <javier@rock-n-code.com>
1 line
14 KiB
JSON
1 line
14 KiB
JSON
{"primaryContentSections":[{"kind":"declarations","declarations":[{"platforms":["macOS"],"tokens":[{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"deleteFromWantlist"},{"kind":"text","text":"("},{"kind":"externalParam","text":"path"},{"kind":"text","text":": "},{"preciseIdentifier":"s:14DiscogsService10OperationsO","kind":"typeIdentifier","text":"Operations","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations"},{"kind":"text","text":"."},{"preciseIdentifier":"s:14DiscogsService10OperationsO18DeleteFromWantlistO","kind":"typeIdentifier","text":"DeleteFromWantlist","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/DeleteFromWantlist"},{"kind":"text","text":"."},{"preciseIdentifier":"s:14DiscogsService10OperationsO18DeleteFromWantlistO5InputV","kind":"typeIdentifier","text":"Input","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/DeleteFromWantlist\/Input"},{"kind":"text","text":"."},{"preciseIdentifier":"s:14DiscogsService10OperationsO18DeleteFromWantlistO5InputV4PathV","kind":"typeIdentifier","text":"Path","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/DeleteFromWantlist\/Input\/Path-swift.struct"},{"kind":"text","text":", "},{"kind":"externalParam","text":"headers"},{"kind":"text","text":": "},{"preciseIdentifier":"s:14DiscogsService10OperationsO","kind":"typeIdentifier","text":"Operations","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations"},{"kind":"text","text":"."},{"preciseIdentifier":"s:14DiscogsService10OperationsO18DeleteFromWantlistO","kind":"typeIdentifier","text":"DeleteFromWantlist","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/DeleteFromWantlist"},{"kind":"text","text":"."},{"preciseIdentifier":"s:14DiscogsService10OperationsO18DeleteFromWantlistO5InputV","kind":"typeIdentifier","text":"Input","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/DeleteFromWantlist\/Input"},{"kind":"text","text":"."},{"preciseIdentifier":"s:14DiscogsService10OperationsO18DeleteFromWantlistO5InputV7HeadersV","kind":"typeIdentifier","text":"Headers","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/DeleteFromWantlist\/Input\/Headers-swift.struct"},{"kind":"text","text":" = .init()) "},{"kind":"keyword","text":"async"},{"kind":"text","text":" "},{"kind":"keyword","text":"throws"},{"kind":"text","text":" -> "},{"preciseIdentifier":"s:14DiscogsService10OperationsO","kind":"typeIdentifier","text":"Operations","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations"},{"kind":"text","text":"."},{"preciseIdentifier":"s:14DiscogsService10OperationsO18DeleteFromWantlistO","kind":"typeIdentifier","text":"DeleteFromWantlist","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/DeleteFromWantlist"},{"kind":"text","text":"."},{"preciseIdentifier":"s:14DiscogsService10OperationsO18DeleteFromWantlistO6OutputO","kind":"typeIdentifier","text":"Output","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/DeleteFromWantlist\/Output"}],"languages":["swift"]}]},{"content":[{"level":2,"anchor":"discussion","type":"heading","text":"Discussion"},{"inlineContent":[{"type":"text","text":"Deletes a release from a wantlist of a user."}],"type":"paragraph"},{"inlineContent":[{"type":"text","text":"This endpoint requires authentication as the wantlist owner."}],"type":"paragraph"},{"name":"Remark","content":[{"inlineContent":[{"text":"HTTP ","type":"text"},{"code":"DELETE \/users\/{username}\/wants\/{release_id}","type":"codeVoice"},{"text":".","type":"text"}],"type":"paragraph"}],"style":"note","type":"aside"},{"name":"Remark","content":[{"inlineContent":[{"text":"Generated from ","type":"text"},{"code":"#\/paths\/\/users\/{username}\/wants\/{release_id}\/delete(deleteFromWantlist)","type":"codeVoice"},{"text":".","type":"text"}],"type":"paragraph"}],"style":"note","type":"aside"}],"kind":"content"}],"sections":[],"metadata":{"roleHeading":"Instance Method","extendedModule":"DiscogsService","symbolKind":"method","title":"deleteFromWantlist(path:headers:)","modules":[{"name":"DiscogsService"}],"externalID":"s:14DiscogsService11APIProtocolPAAE18deleteFromWantlist4path7headersAA10OperationsO06DeleteeF0O6OutputOAJ5InputV4PathV_AN7HeadersVtYaKF::SYNTHESIZED::s:14DiscogsService6ClientV","role":"symbol","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"deleteFromWantlist"},{"kind":"text","text":"("},{"kind":"externalParam","text":"path"},{"kind":"text","text":": "},{"text":"Operations","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO"},{"text":".","kind":"text"},{"text":"DeleteFromWantlist","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO18DeleteFromWantlistO"},{"text":".","kind":"text"},{"text":"Input","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO18DeleteFromWantlistO5InputV"},{"kind":"text","text":"."},{"preciseIdentifier":"s:14DiscogsService10OperationsO18DeleteFromWantlistO5InputV4PathV","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:14DiscogsService10OperationsO18DeleteFromWantlistO","text":"DeleteFromWantlist","kind":"typeIdentifier"},{"text":".","kind":"text"},{"kind":"typeIdentifier","text":"Input","preciseIdentifier":"s:14DiscogsService10OperationsO18DeleteFromWantlistO5InputV"},{"kind":"text","text":"."},{"preciseIdentifier":"s:14DiscogsService10OperationsO18DeleteFromWantlistO5InputV7HeadersV","text":"Headers","kind":"typeIdentifier"},{"kind":"text","text":") "},{"text":"async","kind":"keyword"},{"kind":"text","text":" "},{"text":"throws","kind":"keyword"},{"text":" -> ","kind":"text"},{"text":"Operations","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO"},{"text":".","kind":"text"},{"text":"DeleteFromWantlist","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO18DeleteFromWantlistO"},{"text":".","kind":"text"},{"preciseIdentifier":"s:14DiscogsService10OperationsO18DeleteFromWantlistO6OutputO","text":"Output","kind":"typeIdentifier"}]},"hierarchy":{"paths":[["doc:\/\/DiscogsService\/documentation\/DiscogsService","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Client"]]},"schemaVersion":{"patch":0,"major":0,"minor":3},"abstract":[{"text":"Delete a release from a wantlist of a user.","type":"text"}],"variants":[{"paths":["\/documentation\/discogsservice\/client\/deletefromwantlist(path:headers:)"],"traits":[{"interfaceLanguage":"swift"}]}],"identifier":{"url":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Client\/deleteFromWantlist(path:headers:)","interfaceLanguage":"swift"},"kind":"symbol","references":{"doc://DiscogsService/documentation/DiscogsService/Operations/DeleteFromWantlist/Input":{"url":"\/documentation\/discogsservice\/operations\/deletefromwantlist\/input","kind":"symbol","abstract":[],"type":"topic","role":"symbol","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Input","kind":"identifier"}],"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/DeleteFromWantlist\/Input","navigatorTitle":[{"kind":"identifier","text":"Input"}],"title":"Operations.DeleteFromWantlist.Input"},"doc://DiscogsService/documentation/DiscogsService":{"url":"\/documentation\/discogsservice","role":"collection","abstract":[],"title":"DiscogsService","type":"topic","kind":"symbol","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService"},"doc://DiscogsService/documentation/DiscogsService/Operations/DeleteFromWantlist/Output":{"abstract":[],"url":"\/documentation\/discogsservice\/operations\/deletefromwantlist\/output","fragments":[{"text":"enum","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"Output"}],"navigatorTitle":[{"text":"Output","kind":"identifier"}],"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/DeleteFromWantlist\/Output","kind":"symbol","title":"Operations.DeleteFromWantlist.Output","type":"topic","role":"symbol"},"doc://DiscogsService/documentation/DiscogsService/Operations/DeleteFromWantlist/Input/Headers-swift.struct":{"url":"\/documentation\/discogsservice\/operations\/deletefromwantlist\/input\/headers-swift.struct","abstract":[],"title":"Operations.DeleteFromWantlist.Input.Headers","type":"topic","role":"symbol","navigatorTitle":[{"text":"Headers","kind":"identifier"}],"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/DeleteFromWantlist\/Input\/Headers-swift.struct","kind":"symbol","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Headers","kind":"identifier"}]},"doc://DiscogsService/documentation/DiscogsService/Operations/DeleteFromWantlist":{"url":"\/documentation\/discogsservice\/operations\/deletefromwantlist","kind":"symbol","abstract":[{"type":"text","text":"Delete a release from a wantlist of a user."}],"type":"topic","role":"symbol","fragments":[{"kind":"keyword","text":"enum"},{"text":" ","kind":"text"},{"text":"DeleteFromWantlist","kind":"identifier"}],"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/DeleteFromWantlist","navigatorTitle":[{"text":"DeleteFromWantlist","kind":"identifier"}],"title":"Operations.DeleteFromWantlist"},"doc://DiscogsService/documentation/DiscogsService/Client":{"type":"topic","navigatorTitle":[{"text":"Client","kind":"identifier"}],"title":"Client","kind":"symbol","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Client","kind":"identifier"}],"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":[{"type":"text","text":"User Collections"}],"type":"emphasis"},{"text":" and ","type":"text"},{"inlineContent":[{"text":"Wantlists","type":"text"}],"type":"emphasis"},{"type":"text","text":", create "},{"type":"emphasis","inlineContent":[{"text":"Marketplace","type":"text"}]},{"type":"text","text":" listings, and more."}],"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Client","role":"symbol","url":"\/documentation\/discogsservice\/client"},"doc://DiscogsService/documentation/DiscogsService/Client/deleteFromWantlist(path:headers:)":{"kind":"symbol","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Client\/deleteFromWantlist(path:headers:)","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"deleteFromWantlist","kind":"identifier"},{"text":"(","kind":"text"},{"text":"path","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"Operations","preciseIdentifier":"s:14DiscogsService10OperationsO","kind":"typeIdentifier"},{"text":".","kind":"text"},{"text":"DeleteFromWantlist","preciseIdentifier":"s:14DiscogsService10OperationsO18DeleteFromWantlistO","kind":"typeIdentifier"},{"text":".","kind":"text"},{"text":"Input","preciseIdentifier":"s:14DiscogsService10OperationsO18DeleteFromWantlistO5InputV","kind":"typeIdentifier"},{"text":".","kind":"text"},{"text":"Path","preciseIdentifier":"s:14DiscogsService10OperationsO18DeleteFromWantlistO5InputV4PathV","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"headers","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"Operations","preciseIdentifier":"s:14DiscogsService10OperationsO","kind":"typeIdentifier"},{"text":".","kind":"text"},{"text":"DeleteFromWantlist","preciseIdentifier":"s:14DiscogsService10OperationsO18DeleteFromWantlistO","kind":"typeIdentifier"},{"text":".","kind":"text"},{"text":"Input","preciseIdentifier":"s:14DiscogsService10OperationsO18DeleteFromWantlistO5InputV","kind":"typeIdentifier"},{"text":".","kind":"text"},{"text":"Headers","preciseIdentifier":"s:14DiscogsService10OperationsO18DeleteFromWantlistO5InputV7HeadersV","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":"DeleteFromWantlist","preciseIdentifier":"s:14DiscogsService10OperationsO18DeleteFromWantlistO","kind":"typeIdentifier"},{"text":".","kind":"text"},{"text":"Output","preciseIdentifier":"s:14DiscogsService10OperationsO18DeleteFromWantlistO6OutputO","kind":"typeIdentifier"}],"role":"symbol","type":"topic","title":"deleteFromWantlist(path:headers:)","abstract":[{"text":"Delete a release from a wantlist of a user.","type":"text"}],"url":"\/documentation\/discogsservice\/client\/deletefromwantlist(path:headers:)"},"doc://DiscogsService/documentation/DiscogsService/Operations/DeleteFromWantlist/Input/Path-swift.struct":{"url":"\/documentation\/discogsservice\/operations\/deletefromwantlist\/input\/path-swift.struct","abstract":[],"title":"Operations.DeleteFromWantlist.Input.Path","type":"topic","role":"symbol","navigatorTitle":[{"kind":"identifier","text":"Path"}],"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/DeleteFromWantlist\/Input\/Path-swift.struct","kind":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"Path"}]},"doc://DiscogsService/documentation/DiscogsService/Operations":{"kind":"symbol","navigatorTitle":[{"text":"Operations","kind":"identifier"}],"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations","fragments":[{"text":"enum","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Operations","kind":"identifier"}],"role":"symbol","type":"topic","title":"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"}],"url":"\/documentation\/discogsservice\/operations"}}} |