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.2 KiB
JSON
1 line
7.2 KiB
JSON
{"schemaVersion":{"major":0,"minor":3,"patch":0},"sections":[],"primaryContentSections":[{"declarations":[{"platforms":["macOS"],"languages":["swift"],"tokens":[{"text":"enum","kind":"keyword"},{"text":" ","kind":"text"},{"text":"GetStatistics","kind":"identifier"}]}],"kind":"declarations"},{"content":[{"type":"heading","text":"Overview","anchor":"overview","level":2},{"type":"paragraph","inlineContent":[{"text":"Retrieves some statistics for a release in a marketplace.","type":"text"}]},{"type":"paragraph","inlineContent":[{"text":"These statistics reflect the currentt state of a release in a marketplace, and include the number of items currently for sale, lowest listed price of any item for sale, and whether the item is blocked for sale in a marketplace.","type":"text"}]},{"type":"paragraph","inlineContent":[{"text":"This endpoints mandates that authentication is optional. In case of authentication, the lowest currency expressed in their own buyer currency, configurable in buyer settings by default, in the absence of the ","type":"text"},{"code":"curr_abbr","type":"codeVoice"},{"text":" parameter in the query. Otherwise, the price expressed in US dollars, if no currency is provided.","type":"text"}]},{"type":"paragraph","inlineContent":[{"text":"Releases that have no items for sale in a marketplace returns no data in the ","type":"text"},{"code":"lowest_price","type":"codeVoice"},{"text":" and ","type":"text"},{"code":"num_for_sale","type":"codeVoice"},{"text":" keys. Releases that are blocked for sale will also have no data for these keys.","type":"text"}]},{"name":"Remark","type":"aside","content":[{"inlineContent":[{"type":"text","text":"HTTP "},{"type":"codeVoice","code":"GET \/marketplace\/stats\/{release_id}"},{"type":"text","text":"."}],"type":"paragraph"}],"style":"note"},{"name":"Remark","type":"aside","content":[{"inlineContent":[{"type":"text","text":"Generated from "},{"type":"codeVoice","code":"#\/paths\/\/marketplace\/stats\/{release_id}\/get(getStatistics)"},{"type":"text","text":"."}],"type":"paragraph"}],"style":"note"}],"kind":"content"}],"abstract":[{"type":"text","text":"Get some statistics of a release."}],"kind":"symbol","topicSections":[{"generated":true,"anchor":"Structures","title":"Structures","identifiers":["doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetStatistics\/Input"]},{"generated":true,"anchor":"Type-Properties","title":"Type Properties","identifiers":["doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetStatistics\/id"]},{"generated":true,"anchor":"Enumerations","title":"Enumerations","identifiers":["doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetStatistics\/AcceptableContentType","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetStatistics\/Output"]}],"metadata":{"externalID":"s:14DiscogsService10OperationsO13GetStatisticsO","role":"symbol","fragments":[{"text":"enum","kind":"keyword"},{"text":" ","kind":"text"},{"text":"GetStatistics","kind":"identifier"}],"symbolKind":"enum","roleHeading":"Enumeration","navigatorTitle":[{"text":"GetStatistics","kind":"identifier"}],"title":"Operations.GetStatistics","modules":[{"name":"DiscogsService"}]},"hierarchy":{"paths":[["doc:\/\/DiscogsService\/documentation\/DiscogsService","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations"]]},"variants":[{"paths":["\/documentation\/discogsservice\/operations\/getstatistics"],"traits":[{"interfaceLanguage":"swift"}]}],"identifier":{"url":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetStatistics","interfaceLanguage":"swift"},"references":{"doc://DiscogsService/documentation/DiscogsService/Operations/GetStatistics/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"}],"abstract":[],"kind":"symbol","type":"topic","title":"id","url":"\/documentation\/discogsservice\/operations\/getstatistics\/id","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetStatistics\/id"},"doc://DiscogsService/documentation/DiscogsService/Operations/GetStatistics/Output":{"kind":"symbol","fragments":[{"text":"enum","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Output","kind":"identifier"}],"abstract":[],"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetStatistics\/Output","title":"Operations.GetStatistics.Output","url":"\/documentation\/discogsservice\/operations\/getstatistics\/output","role":"symbol","navigatorTitle":[{"text":"Output","kind":"identifier"}],"type":"topic"},"doc://DiscogsService/documentation/DiscogsService/Operations/GetStatistics/AcceptableContentType":{"url":"\/documentation\/discogsservice\/operations\/getstatistics\/acceptablecontenttype","title":"Operations.GetStatistics.AcceptableContentType","role":"symbol","fragments":[{"text":"enum","kind":"keyword"},{"text":" ","kind":"text"},{"text":"AcceptableContentType","kind":"identifier"}],"navigatorTitle":[{"text":"AcceptableContentType","kind":"identifier"}],"kind":"symbol","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetStatistics\/AcceptableContentType","abstract":[],"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/GetStatistics":{"kind":"symbol","fragments":[{"text":"enum","kind":"keyword"},{"text":" ","kind":"text"},{"text":"GetStatistics","kind":"identifier"}],"abstract":[{"text":"Get some statistics of a release.","type":"text"}],"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetStatistics","title":"Operations.GetStatistics","url":"\/documentation\/discogsservice\/operations\/getstatistics","role":"symbol","navigatorTitle":[{"text":"GetStatistics","kind":"identifier"}],"type":"topic"},"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/GetStatistics/Input":{"abstract":[],"kind":"symbol","type":"topic","title":"Operations.GetStatistics.Input","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetStatistics\/Input","url":"\/documentation\/discogsservice\/operations\/getstatistics\/input","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"Input"}],"role":"symbol","navigatorTitle":[{"kind":"identifier","text":"Input"}]}}} |