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":[{"declarations":[{"tokens":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"text":"addToWantlist","kind":"identifier"},{"kind":"text","text":"("},{"kind":"externalParam","text":"_"},{"kind":"text","text":" "},{"kind":"internalParam","text":"input"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","text":"Operations","preciseIdentifier":"s:14DiscogsService10OperationsO","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations"},{"kind":"text","text":"."},{"kind":"typeIdentifier","text":"AddToWantlist","preciseIdentifier":"s:14DiscogsService10OperationsO13AddToWantlistO","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/AddToWantlist"},{"text":".","kind":"text"},{"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/AddToWantlist\/Input","kind":"typeIdentifier","text":"Input","preciseIdentifier":"s:14DiscogsService10OperationsO13AddToWantlistO5InputV"},{"kind":"text","text":") "},{"kind":"keyword","text":"async"},{"kind":"text","text":" "},{"kind":"keyword","text":"throws"},{"kind":"text","text":" -> "},{"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations","kind":"typeIdentifier","text":"Operations","preciseIdentifier":"s:14DiscogsService10OperationsO"},{"kind":"text","text":"."},{"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/AddToWantlist","kind":"typeIdentifier","text":"AddToWantlist","preciseIdentifier":"s:14DiscogsService10OperationsO13AddToWantlistO"},{"kind":"text","text":"."},{"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/AddToWantlist\/Output","kind":"typeIdentifier","text":"Output","preciseIdentifier":"s:14DiscogsService10OperationsO13AddToWantlistO6OutputO"}],"platforms":["macOS"],"languages":["swift"]}],"kind":"declarations"},{"content":[{"type":"heading","text":"Discussion","anchor":"discussion","level":2},{"type":"paragraph","inlineContent":[{"text":"Adds a release to a wantlist of a user.","type":"text"}]},{"type":"paragraph","inlineContent":[{"text":"This endpoint requires authentication as the wantlist owner.","type":"text"}]},{"style":"note","type":"aside","content":[{"inlineContent":[{"type":"text","text":"HTTP "},{"code":"PUT \/users\/{username}\/wants\/{release_id}","type":"codeVoice"},{"type":"text","text":"."}],"type":"paragraph"}],"name":"Remark"},{"content":[{"inlineContent":[{"text":"Generated from ","type":"text"},{"type":"codeVoice","code":"#\/paths\/\/users\/{username}\/wants\/{release_id}\/put(addToWantlist)"},{"text":".","type":"text"}],"type":"paragraph"}],"type":"aside","style":"note","name":"Remark"}],"kind":"content"}],"sections":[],"hierarchy":{"paths":[["doc:\/\/DiscogsService\/documentation\/DiscogsService","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Client"]]},"metadata":{"roleHeading":"Instance Method","symbolKind":"method","title":"addToWantlist(_:)","externalID":"s:14DiscogsService6ClientV13addToWantlistyAA10OperationsO03AddeF0O6OutputOAH5InputVYaKF","modules":[{"name":"DiscogsService"}],"role":"symbol","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"addToWantlist","kind":"identifier"},{"text":"(","kind":"text"},{"text":"Operations","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO"},{"text":".","kind":"text"},{"text":"AddToWantlist","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO13AddToWantlistO"},{"kind":"text","text":"."},{"text":"Input","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO13AddToWantlistO5InputV"},{"kind":"text","text":") "},{"kind":"keyword","text":"async"},{"text":" ","kind":"text"},{"kind":"keyword","text":"throws"},{"text":" -> ","kind":"text"},{"kind":"typeIdentifier","text":"Operations","preciseIdentifier":"s:14DiscogsService10OperationsO"},{"kind":"text","text":"."},{"kind":"typeIdentifier","text":"AddToWantlist","preciseIdentifier":"s:14DiscogsService10OperationsO13AddToWantlistO"},{"kind":"text","text":"."},{"kind":"typeIdentifier","text":"Output","preciseIdentifier":"s:14DiscogsService10OperationsO13AddToWantlistO6OutputO"}]},"schemaVersion":{"minor":3,"patch":0,"major":0},"abstract":[{"type":"text","text":"Add a release into a wantlist of a user."}],"variants":[{"paths":["\/documentation\/discogsservice\/client\/addtowantlist(_:)"],"traits":[{"interfaceLanguage":"swift"}]}],"identifier":{"url":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Client\/addToWantlist(_:)","interfaceLanguage":"swift"},"seeAlsoSections":[{"generated":true,"anchor":"User-Wantlist","identifiers":["doc:\/\/DiscogsService\/documentation\/DiscogsService\/Client\/getWantlist(_:)","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Client\/updateInWantlist(_:)","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Client\/deleteFromWantlist(_:)"],"title":"User Wantlist"}],"kind":"symbol","references":{"doc://DiscogsService/documentation/DiscogsService/Operations/AddToWantlist/Input":{"url":"\/documentation\/discogsservice\/operations\/addtowantlist\/input","abstract":[],"title":"Operations.AddToWantlist.Input","type":"topic","role":"symbol","navigatorTitle":[{"text":"Input","kind":"identifier"}],"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/AddToWantlist\/Input","kind":"symbol","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Input","kind":"identifier"}]},"doc://DiscogsService/documentation/DiscogsService/Client/deleteFromWantlist(_:)":{"url":"\/documentation\/discogsservice\/client\/deletefromwantlist(_:)","role":"symbol","abstract":[{"type":"text","text":"Delete a release from a wantlist of a user."}],"title":"deleteFromWantlist(_:)","type":"topic","kind":"symbol","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"deleteFromWantlist"},{"kind":"text","text":"("},{"kind":"typeIdentifier","text":"Operations","preciseIdentifier":"s:14DiscogsService10OperationsO"},{"kind":"text","text":"."},{"kind":"typeIdentifier","text":"DeleteFromWantlist","preciseIdentifier":"s:14DiscogsService10OperationsO18DeleteFromWantlistO"},{"kind":"text","text":"."},{"kind":"typeIdentifier","text":"Input","preciseIdentifier":"s:14DiscogsService10OperationsO18DeleteFromWantlistO5InputV"},{"kind":"text","text":") "},{"kind":"keyword","text":"async"},{"kind":"text","text":" "},{"kind":"keyword","text":"throws"},{"kind":"text","text":" -> "},{"kind":"typeIdentifier","text":"Operations","preciseIdentifier":"s:14DiscogsService10OperationsO"},{"kind":"text","text":"."},{"kind":"typeIdentifier","text":"DeleteFromWantlist","preciseIdentifier":"s:14DiscogsService10OperationsO18DeleteFromWantlistO"},{"kind":"text","text":"."},{"kind":"typeIdentifier","text":"Output","preciseIdentifier":"s:14DiscogsService10OperationsO18DeleteFromWantlistO6OutputO"}],"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Client\/deleteFromWantlist(_:)"},"doc://DiscogsService/documentation/DiscogsService/Operations/AddToWantlist":{"url":"\/documentation\/discogsservice\/operations\/addtowantlist","kind":"symbol","abstract":[{"text":"Add a release into a wantlist of a user.","type":"text"}],"type":"topic","role":"symbol","fragments":[{"text":"enum","kind":"keyword"},{"text":" ","kind":"text"},{"text":"AddToWantlist","kind":"identifier"}],"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/AddToWantlist","navigatorTitle":[{"text":"AddToWantlist","kind":"identifier"}],"title":"Operations.AddToWantlist"},"doc://DiscogsService/documentation/DiscogsService/Operations/AddToWantlist/Output":{"kind":"symbol","navigatorTitle":[{"kind":"identifier","text":"Output"}],"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/AddToWantlist\/Output","fragments":[{"text":"enum","kind":"keyword"},{"kind":"text","text":" "},{"text":"Output","kind":"identifier"}],"role":"symbol","type":"topic","title":"Operations.AddToWantlist.Output","abstract":[],"url":"\/documentation\/discogsservice\/operations\/addtowantlist\/output"},"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/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"},"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/Client/updateInWantlist(_:)":{"url":"\/documentation\/discogsservice\/client\/updateinwantlist(_:)","role":"symbol","abstract":[{"type":"text","text":"Update a release into a wantlist of a user."}],"title":"updateInWantlist(_:)","type":"topic","kind":"symbol","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"updateInWantlist"},{"kind":"text","text":"("},{"kind":"typeIdentifier","text":"Operations","preciseIdentifier":"s:14DiscogsService10OperationsO"},{"kind":"text","text":"."},{"kind":"typeIdentifier","text":"UpdateInWantlist","preciseIdentifier":"s:14DiscogsService10OperationsO16UpdateInWantlistO"},{"kind":"text","text":"."},{"kind":"typeIdentifier","text":"Input","preciseIdentifier":"s:14DiscogsService10OperationsO16UpdateInWantlistO5InputV"},{"kind":"text","text":") "},{"kind":"keyword","text":"async"},{"kind":"text","text":" "},{"kind":"keyword","text":"throws"},{"kind":"text","text":" -> "},{"kind":"typeIdentifier","text":"Operations","preciseIdentifier":"s:14DiscogsService10OperationsO"},{"kind":"text","text":"."},{"kind":"typeIdentifier","text":"UpdateInWantlist","preciseIdentifier":"s:14DiscogsService10OperationsO16UpdateInWantlistO"},{"kind":"text","text":"."},{"kind":"typeIdentifier","text":"Output","preciseIdentifier":"s:14DiscogsService10OperationsO16UpdateInWantlistO6OutputO"}],"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Client\/updateInWantlist(_:)"},"doc://DiscogsService/documentation/DiscogsService/Client/getWantlist(_:)":{"url":"\/documentation\/discogsservice\/client\/getwantlist(_:)","role":"symbol","abstract":[{"type":"text","text":"Get a list of releases in a wantlist of a user."}],"title":"getWantlist(_:)","type":"topic","kind":"symbol","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"getWantlist"},{"kind":"text","text":"("},{"kind":"typeIdentifier","text":"Operations","preciseIdentifier":"s:14DiscogsService10OperationsO"},{"kind":"text","text":"."},{"kind":"typeIdentifier","text":"GetWantlist","preciseIdentifier":"s:14DiscogsService10OperationsO11GetWantlistO"},{"kind":"text","text":"."},{"kind":"typeIdentifier","text":"Input","preciseIdentifier":"s:14DiscogsService10OperationsO11GetWantlistO5InputV"},{"kind":"text","text":") "},{"kind":"keyword","text":"async"},{"kind":"text","text":" "},{"kind":"keyword","text":"throws"},{"kind":"text","text":" -> "},{"kind":"typeIdentifier","text":"Operations","preciseIdentifier":"s:14DiscogsService10OperationsO"},{"kind":"text","text":"."},{"kind":"typeIdentifier","text":"GetWantlist","preciseIdentifier":"s:14DiscogsService10OperationsO11GetWantlistO"},{"kind":"text","text":"."},{"kind":"typeIdentifier","text":"Output","preciseIdentifier":"s:14DiscogsService10OperationsO11GetWantlistO6OutputO"}],"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Client\/getWantlist(_:)"},"doc://DiscogsService/documentation/DiscogsService/Client/addToWantlist(_:)":{"url":"\/documentation\/discogsservice\/client\/addtowantlist(_:)","role":"symbol","abstract":[{"type":"text","text":"Add a release into a wantlist of a user."}],"title":"addToWantlist(_:)","type":"topic","kind":"symbol","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"addToWantlist"},{"kind":"text","text":"("},{"kind":"typeIdentifier","text":"Operations","preciseIdentifier":"s:14DiscogsService10OperationsO"},{"kind":"text","text":"."},{"kind":"typeIdentifier","text":"AddToWantlist","preciseIdentifier":"s:14DiscogsService10OperationsO13AddToWantlistO"},{"kind":"text","text":"."},{"kind":"typeIdentifier","text":"Input","preciseIdentifier":"s:14DiscogsService10OperationsO13AddToWantlistO5InputV"},{"kind":"text","text":") "},{"kind":"keyword","text":"async"},{"kind":"text","text":" "},{"kind":"keyword","text":"throws"},{"kind":"text","text":" -> "},{"kind":"typeIdentifier","text":"Operations","preciseIdentifier":"s:14DiscogsService10OperationsO"},{"kind":"text","text":"."},{"kind":"typeIdentifier","text":"AddToWantlist","preciseIdentifier":"s:14DiscogsService10OperationsO13AddToWantlistO"},{"kind":"text","text":"."},{"preciseIdentifier":"s:14DiscogsService10OperationsO13AddToWantlistO6OutputO","text":"Output","kind":"typeIdentifier"}],"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Client\/addToWantlist(_:)"}}} |