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
17 KiB
JSON
1 line
17 KiB
JSON
{"schemaVersion":{"minor":3,"patch":0,"major":0},"sections":[],"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"kind":"attribute","text":"@frozen"},{"kind":"text","text":" "},{"kind":"keyword","text":"enum"},{"kind":"text","text":" "},{"kind":"identifier","text":"Output"}],"platforms":["macOS"],"languages":["swift"]}]}],"relationshipsSections":[{"kind":"relationships","title":"Conforms To","identifiers":["doc:\/\/DiscogsService\/SQ","doc:\/\/DiscogsService\/SH","doc:\/\/DiscogsService\/s8SendableP","doc:\/\/DiscogsService\/s16SendableMetatypeP"],"type":"conformsTo"}],"kind":"symbol","topicSections":[{"identifiers":["doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetPriceSuggestions\/Output\/Ok-swift.struct"],"generated":true,"anchor":"Structures","title":"Structures"},{"identifiers":["doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetPriceSuggestions\/Output\/internalServerError(_:)","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetPriceSuggestions\/Output\/notFound(_:)","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetPriceSuggestions\/Output\/ok(_:)","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetPriceSuggestions\/Output\/unauthorized(_:)","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetPriceSuggestions\/Output\/undocumented(statusCode:_:)"],"generated":true,"anchor":"Enumeration-Cases","title":"Enumeration Cases"},{"identifiers":["doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetPriceSuggestions\/Output\/internalServerError","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetPriceSuggestions\/Output\/notFound","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetPriceSuggestions\/Output\/ok-swift.property","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetPriceSuggestions\/Output\/unauthorized"],"generated":true,"anchor":"Instance-Properties","title":"Instance Properties"},{"identifiers":["doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetPriceSuggestions\/Output\/Equatable-Implementations"],"generated":true,"anchor":"Default-Implementations","title":"Default Implementations"}],"metadata":{"symbolKind":"enum","title":"Operations.GetPriceSuggestions.Output","externalID":"s:14DiscogsService10OperationsO19GetPriceSuggestionsO6OutputO","roleHeading":"Enumeration","fragments":[{"text":"enum","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Output","kind":"identifier"}],"navigatorTitle":[{"kind":"identifier","text":"Output"}],"modules":[{"name":"DiscogsService"}],"role":"symbol"},"hierarchy":{"paths":[["doc:\/\/DiscogsService\/documentation\/DiscogsService","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetPriceSuggestions"]]},"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/discogsservice\/operations\/getpricesuggestions\/output"]}],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetPriceSuggestions\/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/GetPriceSuggestions/Output/unauthorized":{"kind":"symbol","fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"unauthorized","kind":"identifier"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:14DiscogsService10ComponentsO","text":"Components","kind":"typeIdentifier"},{"text":".","kind":"text"},{"preciseIdentifier":"s:14DiscogsService10ComponentsO9ResponsesO","text":"Responses","kind":"typeIdentifier"},{"kind":"text","text":"."},{"preciseIdentifier":"s:14DiscogsService10ComponentsO9ResponsesO12UnauthorizedV","kind":"typeIdentifier","text":"Unauthorized"}],"abstract":[{"type":"text","text":"The associated value of the enum case if "},{"type":"codeVoice","code":"self"},{"type":"text","text":" is "},{"type":"codeVoice","code":".unauthorized"},{"type":"text","text":"."}],"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetPriceSuggestions\/Output\/unauthorized","title":"unauthorized","url":"\/documentation\/discogsservice\/operations\/getpricesuggestions\/output\/unauthorized","role":"symbol","type":"topic"},"doc://DiscogsService/s16SendableMetatypeP":{"type":"unresolvable","identifier":"doc:\/\/DiscogsService\/s16SendableMetatypeP","title":"Swift.SendableMetatype"},"doc://DiscogsService/documentation/DiscogsService":{"title":"DiscogsService","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService","url":"\/documentation\/discogsservice","abstract":[],"role":"collection","kind":"symbol","type":"topic"},"doc://DiscogsService/s8SendableP":{"type":"unresolvable","identifier":"doc:\/\/DiscogsService\/s8SendableP","title":"Swift.Sendable"},"doc://DiscogsService/documentation/DiscogsService/Operations/GetPriceSuggestions/Output":{"url":"\/documentation\/discogsservice\/operations\/getpricesuggestions\/output","title":"Operations.GetPriceSuggestions.Output","role":"symbol","fragments":[{"kind":"keyword","text":"enum"},{"kind":"text","text":" "},{"kind":"identifier","text":"Output"}],"navigatorTitle":[{"kind":"identifier","text":"Output"}],"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetPriceSuggestions\/Output","kind":"symbol","abstract":[],"type":"topic"},"doc://DiscogsService/documentation/DiscogsService/Operations/GetPriceSuggestions/Output/Equatable-Implementations":{"role":"collectionGroup","abstract":[],"kind":"article","type":"topic","title":"Equatable Implementations","url":"\/documentation\/discogsservice\/operations\/getpricesuggestions\/output\/equatable-implementations","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetPriceSuggestions\/Output\/Equatable-Implementations"},"doc://DiscogsService/documentation/DiscogsService/Operations/GetPriceSuggestions/Output/undocumented(statusCode:_:)":{"role":"symbol","fragments":[{"kind":"keyword","text":"case"},{"kind":"text","text":" "},{"kind":"identifier","text":"undocumented"},{"kind":"text","text":"("},{"kind":"externalParam","text":"statusCode"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Int","preciseIdentifier":"s:Si"},{"kind":"text","text":", "},{"kind":"typeIdentifier","text":"UndocumentedPayload","preciseIdentifier":"s:14OpenAPIRuntime19UndocumentedPayloadV"},{"kind":"text","text":")"}],"abstract":[{"type":"text","text":"Undocumented response."}],"kind":"symbol","type":"topic","title":"Operations.GetPriceSuggestions.Output.undocumented(statusCode:_:)","url":"\/documentation\/discogsservice\/operations\/getpricesuggestions\/output\/undocumented(statuscode:_:)","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetPriceSuggestions\/Output\/undocumented(statusCode:_:)"},"doc://DiscogsService/documentation/DiscogsService/Operations/GetPriceSuggestions/Output/notFound(_:)":{"role":"symbol","fragments":[{"kind":"keyword","text":"case"},{"kind":"text","text":" "},{"kind":"identifier","text":"notFound"},{"kind":"text","text":"("},{"kind":"typeIdentifier","text":"Components","preciseIdentifier":"s:14DiscogsService10ComponentsO"},{"kind":"text","text":"."},{"kind":"typeIdentifier","text":"Responses","preciseIdentifier":"s:14DiscogsService10ComponentsO9ResponsesO"},{"kind":"text","text":"."},{"kind":"typeIdentifier","text":"NotFound","preciseIdentifier":"s:14DiscogsService10ComponentsO9ResponsesO8NotFoundV"},{"kind":"text","text":")"}],"abstract":[{"type":"text","text":"A requested resource cannot be found."}],"kind":"symbol","type":"topic","title":"Operations.GetPriceSuggestions.Output.notFound(_:)","url":"\/documentation\/discogsservice\/operations\/getpricesuggestions\/output\/notfound(_:)","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetPriceSuggestions\/Output\/notFound(_:)"},"doc://DiscogsService/documentation/DiscogsService/Operations/GetPriceSuggestions/Output/Ok-swift.struct":{"kind":"symbol","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Ok","kind":"identifier"}],"abstract":[],"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetPriceSuggestions\/Output\/Ok-swift.struct","title":"Operations.GetPriceSuggestions.Output.Ok","url":"\/documentation\/discogsservice\/operations\/getpricesuggestions\/output\/ok-swift.struct","role":"symbol","navigatorTitle":[{"text":"Ok","kind":"identifier"}],"type":"topic"},"doc://DiscogsService/documentation/DiscogsService/Operations/GetPriceSuggestions/Output/ok(_:)":{"role":"symbol","fragments":[{"kind":"keyword","text":"case"},{"kind":"text","text":" "},{"kind":"identifier","text":"ok"},{"kind":"text","text":"("},{"kind":"typeIdentifier","text":"Operations","preciseIdentifier":"s:14DiscogsService10OperationsO"},{"kind":"text","text":"."},{"kind":"typeIdentifier","text":"GetPriceSuggestions","preciseIdentifier":"s:14DiscogsService10OperationsO19GetPriceSuggestionsO"},{"kind":"text","text":"."},{"kind":"typeIdentifier","text":"Output","preciseIdentifier":"s:14DiscogsService10OperationsO19GetPriceSuggestionsO6OutputO"},{"kind":"text","text":"."},{"kind":"typeIdentifier","text":"Ok","preciseIdentifier":"s:14DiscogsService10OperationsO19GetPriceSuggestionsO6OutputO2OkV"},{"kind":"text","text":")"}],"abstract":[{"type":"text","text":"Successfully retrieved price suggestions for a given release."}],"kind":"symbol","type":"topic","title":"Operations.GetPriceSuggestions.Output.ok(_:)","url":"\/documentation\/discogsservice\/operations\/getpricesuggestions\/output\/ok(_:)","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetPriceSuggestions\/Output\/ok(_:)"},"doc://DiscogsService/SQ":{"type":"unresolvable","identifier":"doc:\/\/DiscogsService\/SQ","title":"Swift.Equatable"},"doc://DiscogsService/documentation/DiscogsService/Operations/GetPriceSuggestions/Output/notFound":{"role":"symbol","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"notFound"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Components","preciseIdentifier":"s:14DiscogsService10ComponentsO"},{"kind":"text","text":"."},{"kind":"typeIdentifier","text":"Responses","preciseIdentifier":"s:14DiscogsService10ComponentsO9ResponsesO"},{"kind":"text","text":"."},{"kind":"typeIdentifier","text":"NotFound","preciseIdentifier":"s:14DiscogsService10ComponentsO9ResponsesO8NotFoundV"}],"abstract":[{"type":"text","text":"The associated value of the enum case if "},{"type":"codeVoice","code":"self"},{"type":"text","text":" is "},{"type":"codeVoice","code":".notFound"},{"type":"text","text":"."}],"kind":"symbol","type":"topic","title":"notFound","url":"\/documentation\/discogsservice\/operations\/getpricesuggestions\/output\/notfound","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetPriceSuggestions\/Output\/notFound"},"doc://DiscogsService/documentation/DiscogsService/Operations/GetPriceSuggestions":{"kind":"symbol","fragments":[{"text":"enum","kind":"keyword"},{"text":" ","kind":"text"},{"text":"GetPriceSuggestions","kind":"identifier"}],"abstract":[{"text":"Get some price suggestions for a given release.","type":"text"}],"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetPriceSuggestions","title":"Operations.GetPriceSuggestions","url":"\/documentation\/discogsservice\/operations\/getpricesuggestions","role":"symbol","navigatorTitle":[{"text":"GetPriceSuggestions","kind":"identifier"}],"type":"topic"},"doc://DiscogsService/SH":{"type":"unresolvable","identifier":"doc:\/\/DiscogsService\/SH","title":"Swift.Hashable"},"doc://DiscogsService/documentation/DiscogsService/Operations/GetPriceSuggestions/Output/internalServerError":{"role":"symbol","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"internalServerError"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Components","preciseIdentifier":"s:14DiscogsService10ComponentsO"},{"kind":"text","text":"."},{"kind":"typeIdentifier","text":"Responses","preciseIdentifier":"s:14DiscogsService10ComponentsO9ResponsesO"},{"kind":"text","text":"."},{"kind":"typeIdentifier","text":"InternalError","preciseIdentifier":"s:14DiscogsService10ComponentsO9ResponsesO13InternalErrorV"}],"abstract":[{"type":"text","text":"The associated value of the enum case if "},{"type":"codeVoice","code":"self"},{"type":"text","text":" is "},{"type":"codeVoice","code":".internalServerError"},{"type":"text","text":"."}],"kind":"symbol","type":"topic","title":"internalServerError","url":"\/documentation\/discogsservice\/operations\/getpricesuggestions\/output\/internalservererror","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetPriceSuggestions\/Output\/internalServerError"},"doc://DiscogsService/documentation/DiscogsService/Operations/GetPriceSuggestions/Output/ok-swift.property":{"title":"ok","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetPriceSuggestions\/Output\/ok-swift.property","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"text":"ok","kind":"identifier"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:14DiscogsService10OperationsO","text":"Operations","kind":"typeIdentifier"},{"text":".","kind":"text"},{"preciseIdentifier":"s:14DiscogsService10OperationsO19GetPriceSuggestionsO","text":"GetPriceSuggestions","kind":"typeIdentifier"},{"kind":"text","text":"."},{"preciseIdentifier":"s:14DiscogsService10OperationsO19GetPriceSuggestionsO6OutputO","kind":"typeIdentifier","text":"Output"},{"kind":"text","text":"."},{"preciseIdentifier":"s:14DiscogsService10OperationsO19GetPriceSuggestionsO6OutputO2OkV","kind":"typeIdentifier","text":"Ok"}],"url":"\/documentation\/discogsservice\/operations\/getpricesuggestions\/output\/ok-swift.property","abstract":[{"type":"text","text":"The associated value of the enum case if "},{"type":"codeVoice","code":"self"},{"type":"text","text":" is "},{"type":"codeVoice","code":".ok"},{"type":"text","text":"."}],"role":"symbol","kind":"symbol","type":"topic"},"doc://DiscogsService/documentation/DiscogsService/Operations/GetPriceSuggestions/Output/internalServerError(_:)":{"title":"Operations.GetPriceSuggestions.Output.internalServerError(_:)","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetPriceSuggestions\/Output\/internalServerError(_:)","fragments":[{"kind":"keyword","text":"case"},{"text":" ","kind":"text"},{"text":"internalServerError","kind":"identifier"},{"text":"(","kind":"text"},{"text":"Components","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10ComponentsO"},{"text":".","kind":"text"},{"text":"Responses","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10ComponentsO9ResponsesO"},{"text":".","kind":"text"},{"text":"InternalError","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10ComponentsO9ResponsesO13InternalErrorV"},{"text":")","kind":"text"}],"url":"\/documentation\/discogsservice\/operations\/getpricesuggestions\/output\/internalservererror(_:)","abstract":[{"text":"An Internal Server error was encountered.","type":"text"}],"role":"symbol","kind":"symbol","type":"topic"},"doc://DiscogsService/documentation/DiscogsService/Operations/GetPriceSuggestions/Output/unauthorized(_:)":{"role":"symbol","fragments":[{"text":"case","kind":"keyword"},{"text":" ","kind":"text"},{"text":"unauthorized","kind":"identifier"},{"text":"(","kind":"text"},{"text":"Components","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10ComponentsO"},{"text":".","kind":"text"},{"text":"Responses","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10ComponentsO9ResponsesO"},{"text":".","kind":"text"},{"text":"Unauthorized","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10ComponentsO9ResponsesO12UnauthorizedV"},{"text":")","kind":"text"}],"abstract":[{"type":"text","text":"A requested resource cannot be accessed due to a lack of authentication."}],"kind":"symbol","type":"topic","title":"Operations.GetPriceSuggestions.Output.unauthorized(_:)","url":"\/documentation\/discogsservice\/operations\/getpricesuggestions\/output\/unauthorized(_:)","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetPriceSuggestions\/Output\/unauthorized(_:)"}}} |