Files
javier eaee2b84f0 Documentation update (#17)
This PR contains the work done to update the overall documentation of the package.

Reviewed-on: #17
Co-authored-by: Javier Cicchelli <javier@rock-n-code.com>
Co-committed-by: Javier Cicchelli <javier@rock-n-code.com>
2026-03-24 01:54:43 +00:00

1 line
6.8 KiB
JSON
Raw Permalink Blame History

This file contains ambiguous Unicode characters
This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.
{"sections":[],"primaryContentSections":[{"declarations":[{"tokens":[{"text":"enum","kind":"keyword"},{"text":" ","kind":"text"},{"text":"GetPriceSuggestions","kind":"identifier"}],"platforms":["macOS"],"languages":["swift"]}],"kind":"declarations"},{"content":[{"type":"heading","level":2,"anchor":"overview","text":"Overview"},{"type":"paragraph","inlineContent":[{"text":"Retrieves price suggestions for a provided release. If no suggestions are available, an empty object will be returned.","type":"text"}]},{"type":"paragraph","inlineContent":[{"type":"text","text":"This endpoint requires authentication and also, the user should have filled out the seller settings. Suggested prices will be denominated in the users selling currency."}]},{"name":"Remark","type":"aside","content":[{"type":"paragraph","inlineContent":[{"text":"HTTP ","type":"text"},{"type":"codeVoice","code":"GET \/marketplace\/price_suggestions\/{release_id}"},{"text":".","type":"text"}]}],"style":"note"},{"name":"Remark","type":"aside","content":[{"inlineContent":[{"text":"Generated from ","type":"text"},{"code":"#\/paths\/\/marketplace\/price_suggestions\/{release_id}\/get(getPriceSuggestions)","type":"codeVoice"},{"text":".","type":"text"}],"type":"paragraph"}],"style":"note"}],"kind":"content"}],"topicSections":[{"title":"Structures","generated":true,"anchor":"Structures","identifiers":["doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetPriceSuggestions\/Input"]},{"title":"Type Properties","generated":true,"anchor":"Type-Properties","identifiers":["doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetPriceSuggestions\/id"]},{"title":"Enumerations","generated":true,"anchor":"Enumerations","identifiers":["doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetPriceSuggestions\/AcceptableContentType","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetPriceSuggestions\/Output"]}],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetPriceSuggestions"},"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/discogsservice\/operations\/getpricesuggestions"]}],"schemaVersion":{"minor":3,"patch":0,"major":0},"abstract":[{"type":"text","text":"Get some price suggestions for a given release."}],"kind":"symbol","hierarchy":{"paths":[["doc:\/\/DiscogsService\/documentation\/DiscogsService","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations"]]},"metadata":{"roleHeading":"Enumeration","externalID":"s:14DiscogsService10OperationsO19GetPriceSuggestionsO","modules":[{"name":"DiscogsService"}],"title":"Operations.GetPriceSuggestions","navigatorTitle":[{"text":"GetPriceSuggestions","kind":"identifier"}],"symbolKind":"enum","fragments":[{"text":"enum","kind":"keyword"},{"text":" ","kind":"text"},{"text":"GetPriceSuggestions","kind":"identifier"}],"role":"symbol"},"references":{"doc://DiscogsService/documentation/DiscogsService/Operations":{"url":"\/documentation\/discogsservice\/operations","abstract":[{"text":"API operations, with input and output types, generated from ","type":"text"},{"code":"#\/paths","type":"codeVoice"},{"type":"text","text":" in the OpenAPI document."}],"navigatorTitle":[{"text":"Operations","kind":"identifier"}],"role":"symbol","fragments":[{"kind":"keyword","text":"enum"},{"kind":"text","text":" "},{"text":"Operations","kind":"identifier"}],"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations","kind":"symbol","type":"topic","title":"Operations"},"doc://DiscogsService/documentation/DiscogsService/Operations/GetPriceSuggestions/Input":{"kind":"symbol","navigatorTitle":[{"kind":"identifier","text":"Input"}],"role":"symbol","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetPriceSuggestions\/Input","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"Input"}],"abstract":[],"title":"Operations.GetPriceSuggestions.Input","type":"topic","url":"\/documentation\/discogsservice\/operations\/getpricesuggestions\/input"},"doc://DiscogsService/documentation/DiscogsService/Operations/GetPriceSuggestions":{"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetPriceSuggestions","title":"Operations.GetPriceSuggestions","url":"\/documentation\/discogsservice\/operations\/getpricesuggestions","type":"topic","abstract":[{"text":"Get some price suggestions for a given release.","type":"text"}],"kind":"symbol","role":"symbol","fragments":[{"text":"enum","kind":"keyword"},{"text":" ","kind":"text"},{"text":"GetPriceSuggestions","kind":"identifier"}],"navigatorTitle":[{"text":"GetPriceSuggestions","kind":"identifier"}]},"doc://DiscogsService/documentation/DiscogsService/Operations/GetPriceSuggestions/AcceptableContentType":{"fragments":[{"text":"enum","kind":"keyword"},{"text":" ","kind":"text"},{"text":"AcceptableContentType","kind":"identifier"}],"navigatorTitle":[{"kind":"identifier","text":"AcceptableContentType"}],"role":"symbol","type":"topic","kind":"symbol","title":"Operations.GetPriceSuggestions.AcceptableContentType","url":"\/documentation\/discogsservice\/operations\/getpricesuggestions\/acceptablecontenttype","abstract":[],"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetPriceSuggestions\/AcceptableContentType"},"doc://DiscogsService/documentation/DiscogsService":{"role":"collection","type":"topic","title":"DiscogsService","kind":"symbol","url":"\/documentation\/discogsservice","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService","abstract":[{"type":"text","text":"A Swift client library for the Discogs API, built on top of Swift OpenAPI."}]},"doc://DiscogsService/documentation/DiscogsService/Operations/GetPriceSuggestions/Output":{"title":"Operations.GetPriceSuggestions.Output","type":"topic","url":"\/documentation\/discogsservice\/operations\/getpricesuggestions\/output","fragments":[{"text":"enum","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Output","kind":"identifier"}],"navigatorTitle":[{"kind":"identifier","text":"Output"}],"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetPriceSuggestions\/Output","kind":"symbol","abstract":[],"role":"symbol"},"doc://DiscogsService/documentation/DiscogsService/Operations/GetPriceSuggestions/id":{"abstract":[],"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetPriceSuggestions\/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"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"}],"title":"id","type":"topic","url":"\/documentation\/discogsservice\/operations\/getpricesuggestions\/id","kind":"symbol"}}}