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
7.7 KiB
JSON
1 line
7.7 KiB
JSON
{"sections":[],"hierarchy":{"paths":[["doc:\/\/DiscogsService\/documentation\/DiscogsService","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations"]]},"primaryContentSections":[{"declarations":[{"tokens":[{"text":"enum","kind":"keyword"},{"text":" ","kind":"text"},{"text":"GetInventory","kind":"identifier"}],"platforms":["macOS"],"languages":["swift"]}],"kind":"declarations"},{"content":[{"text":"Overview","type":"heading","level":2,"anchor":"overview"},{"inlineContent":[{"type":"text","text":"Returns the list of listings for an inventory of a user."}],"type":"paragraph"},{"inlineContent":[{"type":"text","text":"Basic information about each listing and the corresponding release is provided, suitable for display in a list. For detailed information about the release, make another API call to fetch the corresponding Release."}],"type":"paragraph"},{"inlineContent":[{"type":"text","text":"This endpoints accepts pagination and also, in case of authenticated as an inventory owner, items that not only have the "},{"type":"codeVoice","code":"For Sale"},{"type":"text","text":" state will be shown as well as other extra fields in those items such as "},{"type":"codeVoice","code":"weight"},{"type":"text","text":", "},{"type":"codeVoice","code":"format_quality"},{"type":"text","text":", "},{"type":"codeVoice","code":"external_id"},{"type":"text","text":", "},{"type":"codeVoice","code":"location"},{"type":"text","text":", and "},{"type":"codeVoice","code":"quantity_keys"},{"type":"text","text":". Note that the "},{"type":"codeVoice","code":"quantity"},{"type":"text","text":" field is read-only for "},{"type":"emphasis","inlineContent":[{"type":"text","text":"NearMint"}]},{"type":"text","text":" users, who will see "},{"type":"emphasis","inlineContent":[{"type":"text","text":"1"}]},{"type":"text","text":" for all quantity values, regardless of their actual count."}],"type":"paragraph"},{"inlineContent":[{"type":"text","text":"In case the user is authorized, the listing will contain a "},{"type":"codeVoice","code":"in_cart"},{"type":"text","text":" boolean field indicating whether or not this listing is in their cart."}],"type":"paragraph"},{"style":"note","type":"aside","name":"Remark","content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"HTTP "},{"type":"codeVoice","code":"GET \/users\/{username}\/inventory"},{"type":"text","text":"."}]}]},{"style":"note","type":"aside","name":"Remark","content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"Generated from "},{"type":"codeVoice","code":"#\/paths\/\/users\/{username}\/inventory\/get(getInventory)"},{"type":"text","text":"."}]}]}],"kind":"content"}],"metadata":{"symbolKind":"enum","title":"Operations.GetInventory","fragments":[{"text":"enum","kind":"keyword"},{"text":" ","kind":"text"},{"text":"GetInventory","kind":"identifier"}],"navigatorTitle":[{"text":"GetInventory","kind":"identifier"}],"modules":[{"name":"DiscogsService"}],"externalID":"s:14DiscogsService10OperationsO12GetInventoryO","roleHeading":"Enumeration","role":"symbol"},"kind":"symbol","identifier":{"url":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetInventory","interfaceLanguage":"swift"},"abstract":[{"text":"Get the listings in an inventory of a seller.","type":"text"}],"schemaVersion":{"minor":3,"major":0,"patch":0},"variants":[{"paths":["\/documentation\/discogsservice\/operations\/getinventory"],"traits":[{"interfaceLanguage":"swift"}]}],"topicSections":[{"generated":true,"anchor":"Structures","title":"Structures","identifiers":["doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetInventory\/Input"]},{"generated":true,"anchor":"Type-Properties","title":"Type Properties","identifiers":["doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetInventory\/id"]},{"generated":true,"anchor":"Enumerations","title":"Enumerations","identifiers":["doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetInventory\/AcceptableContentType","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetInventory\/Output"]}],"references":{"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/GetInventory/AcceptableContentType":{"kind":"symbol","fragments":[{"text":"enum","kind":"keyword"},{"text":" ","kind":"text"},{"text":"AcceptableContentType","kind":"identifier"}],"abstract":[],"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetInventory\/AcceptableContentType","title":"Operations.GetInventory.AcceptableContentType","url":"\/documentation\/discogsservice\/operations\/getinventory\/acceptablecontenttype","role":"symbol","navigatorTitle":[{"text":"AcceptableContentType","kind":"identifier"}],"type":"topic"},"doc://DiscogsService/documentation/DiscogsService/Operations/GetInventory":{"abstract":[{"text":"Get the listings in an inventory of a seller.","type":"text"}],"kind":"symbol","type":"topic","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetInventory","title":"Operations.GetInventory","url":"\/documentation\/discogsservice\/operations\/getinventory","fragments":[{"text":"enum","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"GetInventory"}],"role":"symbol","navigatorTitle":[{"kind":"identifier","text":"GetInventory"}]},"doc://DiscogsService/documentation/DiscogsService/Operations/GetInventory/Input":{"abstract":[],"kind":"symbol","type":"topic","title":"Operations.GetInventory.Input","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetInventory\/Input","url":"\/documentation\/discogsservice\/operations\/getinventory\/input","fragments":[{"text":"struct","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"Input"}],"role":"symbol","navigatorTitle":[{"text":"Input","kind":"identifier"}]},"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/Operations/GetInventory/id":{"url":"\/documentation\/discogsservice\/operations\/getinventory\/id","title":"id","role":"symbol","fragments":[{"text":"static","kind":"keyword"},{"text":" ","kind":"text"},{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"id","kind":"identifier"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"}],"kind":"symbol","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetInventory\/id","abstract":[],"type":"topic"},"doc://DiscogsService/documentation/DiscogsService/Operations/GetInventory/Output":{"kind":"symbol","fragments":[{"kind":"keyword","text":"enum"},{"kind":"text","text":" "},{"kind":"identifier","text":"Output"}],"abstract":[],"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetInventory\/Output","title":"Operations.GetInventory.Output","url":"\/documentation\/discogsservice\/operations\/getinventory\/output","role":"symbol","navigatorTitle":[{"kind":"identifier","text":"Output"}],"type":"topic"}}} |