Files
discogs-service/docs/data/documentation/discogsservice/client/getwantlist(_:).json
T
javier a0672cc4af Implemented the Marketplace endpoints (#15)
This PR contains the work done to implement the *Marketplace* endpoints for the **Discogs API** backend service, which include the following endpoints:
* GET `/users/{username}/inventory` endpoint
* GET `/marketplace/listings/{listing_id}` endpoint
* DELETE `/marketplace/listings/{listing_id}` endpoint
* POST `/marketplace/listings/{listing_id}` endpoint
* POST `/marketplace/listings` endpoint
* GET `/marketplace/orders` endpoint
* GET `/marketplace/orders/{order_id}` endpoint
* GET `/marketplace/orders/{order_id}/messages` endpoint
* POST `/marketplace/orders/{order_id}/messages` endpoint
* GET `/marketplace/fee/{price}` endpoint
* GET `/marketplace/fee/{price}/{currency}` endpoint
* GET `/marketplace/price_suggestions/{release_id}` endpoint
* GET `/marketplace/stats/{release_id}` endpoint

Reviewed-on: #15
Co-authored-by: Javier Cicchelli <javier@rock-n-code.com>
Co-committed-by: Javier Cicchelli <javier@rock-n-code.com>
2025-11-10 00:34:18 +00:00

1 line
15 KiB
JSON

{"sections":[],"metadata":{"title":"getWantlist(_:)","externalID":"s:14DiscogsService6ClientV11getWantlistyAA10OperationsO03GetE0O6OutputOAH5InputVYaKF","modules":[{"name":"DiscogsService"}],"fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"getWantlist","kind":"identifier"},{"text":"(","kind":"text"},{"text":"Operations","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO"},{"text":".","kind":"text"},{"text":"GetWantlist","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO11GetWantlistO"},{"text":".","kind":"text"},{"text":"Input","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO11GetWantlistO5InputV"},{"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":"GetWantlist","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO11GetWantlistO"},{"text":".","kind":"text"},{"text":"Output","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO11GetWantlistO6OutputO"}],"symbolKind":"method","role":"symbol","roleHeading":"Instance Method"},"hierarchy":{"paths":[["doc:\/\/DiscogsService\/documentation\/DiscogsService","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Client"]]},"identifier":{"url":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Client\/getWantlist(_:)","interfaceLanguage":"swift"},"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/discogsservice\/client\/getwantlist(_:)"]}],"seeAlsoSections":[{"title":"User Wantlist","anchor":"User-Wantlist","identifiers":["doc:\/\/DiscogsService\/documentation\/DiscogsService\/Client\/addToWantlist(_:)","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Client\/updateInWantlist(_:)","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Client\/deleteFromWantlist(_:)"],"generated":true}],"abstract":[{"text":"Get a list of releases in a wantlist of a user.","type":"text"}],"schemaVersion":{"patch":0,"major":0,"minor":3},"primaryContentSections":[{"declarations":[{"platforms":["macOS"],"languages":["swift"],"tokens":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"getWantlist","kind":"identifier"},{"text":"(","kind":"text"},{"text":"_","kind":"externalParam"},{"text":" ","kind":"text"},{"text":"input","kind":"internalParam"},{"text":": ","kind":"text"},{"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations","text":"Operations","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO"},{"text":".","kind":"text"},{"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetWantlist","text":"GetWantlist","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO11GetWantlistO"},{"text":".","kind":"text"},{"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetWantlist\/Input","text":"Input","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO11GetWantlistO5InputV"},{"text":") ","kind":"text"},{"text":"async","kind":"keyword"},{"text":" ","kind":"text"},{"text":"throws","kind":"keyword"},{"text":" -> ","kind":"text"},{"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations","text":"Operations","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO"},{"text":".","kind":"text"},{"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetWantlist","text":"GetWantlist","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO11GetWantlistO"},{"text":".","kind":"text"},{"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetWantlist\/Output","text":"Output","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO11GetWantlistO6OutputO"}]}],"kind":"declarations"},{"content":[{"text":"Discussion","anchor":"discussion","type":"heading","level":2},{"type":"paragraph","inlineContent":[{"type":"text","text":"Returnss the list of releases in a wantlist of a user. Accepts Pagination parameters."}]},{"type":"paragraph","inlineContent":[{"type":"text","text":"Basic information about each release is provided, suitable for display in a list. For detailed information, make another API call to fetch the corresponding release."}]},{"type":"paragraph","inlineContent":[{"type":"text","text":"If the wantlist has been made private by its owner, you must be authenticated as the owner to view it."}]},{"type":"paragraph","inlineContent":[{"type":"text","text":"The notes field will be visible if you are authenticated as the wantlist owner."}]},{"content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"HTTP "},{"type":"codeVoice","code":"GET \/users\/{username}\/wants"},{"type":"text","text":"."}]}],"style":"note","type":"aside","name":"Remark"},{"content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"Generated from "},{"type":"codeVoice","code":"#\/paths\/\/users\/{username}\/wants\/get(getWantlist)"},{"type":"text","text":"."}]}],"style":"note","type":"aside","name":"Remark"}],"kind":"content"}],"kind":"symbol","references":{"doc://DiscogsService/documentation/DiscogsService/Operations/GetWantlist/Input":{"abstract":[],"kind":"symbol","type":"topic","title":"Operations.GetWantlist.Input","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetWantlist\/Input","url":"\/documentation\/discogsservice\/operations\/getwantlist\/input","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"Input"}],"role":"symbol","navigatorTitle":[{"kind":"identifier","text":"Input"}]},"doc://DiscogsService/documentation/DiscogsService/Client/addToWantlist(_:)":{"type":"topic","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"},{"text":".","kind":"text"},{"text":"Input","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO13AddToWantlistO5InputV"},{"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":"AddToWantlist","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO13AddToWantlistO"},{"text":".","kind":"text"},{"text":"Output","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO13AddToWantlistO6OutputO"}],"title":"addToWantlist(_:)","url":"\/documentation\/discogsservice\/client\/addtowantlist(_:)","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Client\/addToWantlist(_:)","abstract":[{"type":"text","text":"Add a release into a wantlist of a user."}],"kind":"symbol"},"doc://DiscogsService/documentation/DiscogsService/Operations":{"type":"topic","role":"symbol","fragments":[{"kind":"keyword","text":"enum"},{"kind":"text","text":" "},{"text":"Operations","kind":"identifier"}],"navigatorTitle":[{"kind":"identifier","text":"Operations"}],"title":"Operations","url":"\/documentation\/discogsservice\/operations","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/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"}],"kind":"symbol"},"doc://DiscogsService/documentation/DiscogsService/Client/getWantlist(_:)":{"kind":"symbol","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"getWantlist","kind":"identifier"},{"text":"(","kind":"text"},{"text":"Operations","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO"},{"text":".","kind":"text"},{"text":"GetWantlist","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO11GetWantlistO"},{"text":".","kind":"text"},{"text":"Input","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO11GetWantlistO5InputV"},{"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":"GetWantlist","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO11GetWantlistO"},{"text":".","kind":"text"},{"text":"Output","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO11GetWantlistO6OutputO"}],"abstract":[{"type":"text","text":"Get a list of releases in a wantlist of a user."}],"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Client\/getWantlist(_:)","title":"getWantlist(_:)","url":"\/documentation\/discogsservice\/client\/getwantlist(_:)","role":"symbol","type":"topic"},"doc://DiscogsService/documentation/DiscogsService/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"},{"type":"emphasis","inlineContent":[{"type":"text","text":"Artists"}]},{"text":", ","type":"text"},{"type":"emphasis","inlineContent":[{"type":"text","text":"Releases"}]},{"text":", and ","type":"text"},{"type":"emphasis","inlineContent":[{"type":"text","text":"Labels"}]},{"text":". Your application can also manage ","type":"text"},{"type":"emphasis","inlineContent":[{"type":"text","text":"User Collections"}]},{"text":" and ","type":"text"},{"type":"emphasis","inlineContent":[{"type":"text","text":"Wantlists"}]},{"text":", create ","type":"text"},{"type":"emphasis","inlineContent":[{"type":"text","text":"Marketplace"}]},{"text":" listings, and more.","type":"text"}],"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Client","title":"Client","url":"\/documentation\/discogsservice\/client","role":"symbol","navigatorTitle":[{"text":"Client","kind":"identifier"}],"type":"topic"},"doc://DiscogsService/documentation/DiscogsService/Operations/GetWantlist":{"abstract":[{"text":"Get a list of releases in a wantlist of a user.","type":"text"}],"kind":"symbol","type":"topic","title":"Operations.GetWantlist","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetWantlist","url":"\/documentation\/discogsservice\/operations\/getwantlist","fragments":[{"kind":"keyword","text":"enum"},{"kind":"text","text":" "},{"kind":"identifier","text":"GetWantlist"}],"role":"symbol","navigatorTitle":[{"kind":"identifier","text":"GetWantlist"}]},"doc://DiscogsService/documentation/DiscogsService/Operations/GetWantlist/Output":{"type":"topic","role":"symbol","fragments":[{"kind":"keyword","text":"enum"},{"kind":"text","text":" "},{"kind":"identifier","text":"Output"}],"navigatorTitle":[{"kind":"identifier","text":"Output"}],"title":"Operations.GetWantlist.Output","url":"\/documentation\/discogsservice\/operations\/getwantlist\/output","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetWantlist\/Output","abstract":[],"kind":"symbol"},"doc://DiscogsService/documentation/DiscogsService/Client/updateInWantlist(_:)":{"kind":"symbol","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"updateInWantlist","kind":"identifier"},{"text":"(","kind":"text"},{"text":"Operations","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO"},{"text":".","kind":"text"},{"text":"UpdateInWantlist","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO16UpdateInWantlistO"},{"text":".","kind":"text"},{"text":"Input","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO16UpdateInWantlistO5InputV"},{"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":"UpdateInWantlist","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO16UpdateInWantlistO"},{"text":".","kind":"text"},{"text":"Output","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO16UpdateInWantlistO6OutputO"}],"abstract":[{"type":"text","text":"Update a release into a wantlist of a user."}],"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Client\/updateInWantlist(_:)","title":"updateInWantlist(_:)","url":"\/documentation\/discogsservice\/client\/updateinwantlist(_:)","role":"symbol","type":"topic"},"doc://DiscogsService/documentation/DiscogsService/Client/deleteFromWantlist(_:)":{"type":"topic","role":"symbol","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"deleteFromWantlist","kind":"identifier"},{"text":"(","kind":"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"},{"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":"DeleteFromWantlist","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO18DeleteFromWantlistO"},{"text":".","kind":"text"},{"text":"Output","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO18DeleteFromWantlistO6OutputO"}],"title":"deleteFromWantlist(_:)","url":"\/documentation\/discogsservice\/client\/deletefromwantlist(_:)","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Client\/deleteFromWantlist(_:)","abstract":[{"type":"text","text":"Delete a release from a wantlist of a user."}],"kind":"symbol"},"doc://DiscogsService/documentation/DiscogsService":{"title":"DiscogsService","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService","url":"\/documentation\/discogsservice","abstract":[],"role":"collection","kind":"symbol","type":"topic"}}}