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