eaee2b84f0
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>
1 line
15 KiB
JSON
1 line
15 KiB
JSON
{"sections":[],"primaryContentSections":[{"declarations":[{"tokens":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"getPriceSuggestions","kind":"identifier"},{"text":"(","kind":"text"},{"text":"path","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"Operations","preciseIdentifier":"s:14DiscogsService10OperationsO","kind":"typeIdentifier","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations"},{"text":".","kind":"text"},{"preciseIdentifier":"s:14DiscogsService10OperationsO19GetPriceSuggestionsO","kind":"typeIdentifier","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetPriceSuggestions","text":"GetPriceSuggestions"},{"kind":"text","text":"."},{"text":"Input","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetPriceSuggestions\/Input","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO19GetPriceSuggestionsO5InputV"},{"text":".","kind":"text"},{"text":"Path","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetPriceSuggestions\/Input\/Path-swift.struct","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO19GetPriceSuggestionsO5InputV4PathV"},{"text":", ","kind":"text"},{"text":"headers","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"Operations","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO"},{"text":".","kind":"text"},{"text":"GetPriceSuggestions","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetPriceSuggestions","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO19GetPriceSuggestionsO"},{"text":".","kind":"text"},{"text":"Input","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetPriceSuggestions\/Input","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO19GetPriceSuggestionsO5InputV"},{"text":".","kind":"text"},{"text":"Headers","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetPriceSuggestions\/Input\/Headers-swift.struct","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO19GetPriceSuggestionsO5InputV7HeadersV"},{"text":" = .init()) ","kind":"text"},{"text":"async","kind":"keyword"},{"text":" ","kind":"text"},{"text":"throws","kind":"keyword"},{"text":" -> ","kind":"text"},{"text":"Operations","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO"},{"text":".","kind":"text"},{"text":"GetPriceSuggestions","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetPriceSuggestions","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO19GetPriceSuggestionsO"},{"text":".","kind":"text"},{"text":"Output","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetPriceSuggestions\/Output","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO19GetPriceSuggestionsO6OutputO"}],"languages":["swift"],"platforms":["macOS"]}],"kind":"declarations"},{"kind":"content","content":[{"text":"Discussion","anchor":"discussion","type":"heading","level":2},{"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":[{"text":"This endpoint requires authentication and also, the user should have filled out the seller settings. Suggested prices will be denominated in the user’s selling currency.","type":"text"}]},{"type":"aside","style":"note","name":"Remark","content":[{"inlineContent":[{"text":"HTTP ","type":"text"},{"code":"GET \/marketplace\/price_suggestions\/{release_id}","type":"codeVoice"},{"text":".","type":"text"}],"type":"paragraph"}]},{"type":"aside","style":"note","name":"Remark","content":[{"type":"paragraph","inlineContent":[{"text":"Generated from ","type":"text"},{"type":"codeVoice","code":"#\/paths\/\/marketplace\/price_suggestions\/{release_id}\/get(getPriceSuggestions)"},{"text":".","type":"text"}]}]}]}],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Client\/getPriceSuggestions(path:headers:)"},"variants":[{"paths":["\/documentation\/discogsservice\/client\/getpricesuggestions(path:headers:)"],"traits":[{"interfaceLanguage":"swift"}]}],"schemaVersion":{"patch":0,"minor":3,"major":0},"abstract":[{"text":"Get some price suggestions for a given release.","type":"text"}],"hierarchy":{"paths":[["doc:\/\/DiscogsService\/documentation\/DiscogsService","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Client"]]},"kind":"symbol","metadata":{"roleHeading":"Instance Method","extendedModule":"DiscogsService","externalID":"s:14DiscogsService11APIProtocolPAAE19getPriceSuggestions4path7headersAA10OperationsO03GeteF0O6OutputOAJ5InputV4PathV_AN7HeadersVtYaKF::SYNTHESIZED::s:14DiscogsService6ClientV","modules":[{"name":"DiscogsService"}],"title":"getPriceSuggestions(path:headers:)","symbolKind":"method","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"getPriceSuggestions"},{"kind":"text","text":"("},{"kind":"externalParam","text":"path"},{"kind":"text","text":": "},{"preciseIdentifier":"s:14DiscogsService10OperationsO","kind":"typeIdentifier","text":"Operations"},{"kind":"text","text":"."},{"preciseIdentifier":"s:14DiscogsService10OperationsO19GetPriceSuggestionsO","kind":"typeIdentifier","text":"GetPriceSuggestions"},{"kind":"text","text":"."},{"text":"Input","preciseIdentifier":"s:14DiscogsService10OperationsO19GetPriceSuggestionsO5InputV","kind":"typeIdentifier"},{"text":".","kind":"text"},{"text":"Path","preciseIdentifier":"s:14DiscogsService10OperationsO19GetPriceSuggestionsO5InputV4PathV","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"headers","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"Operations","preciseIdentifier":"s:14DiscogsService10OperationsO","kind":"typeIdentifier"},{"text":".","kind":"text"},{"text":"GetPriceSuggestions","preciseIdentifier":"s:14DiscogsService10OperationsO19GetPriceSuggestionsO","kind":"typeIdentifier"},{"text":".","kind":"text"},{"text":"Input","preciseIdentifier":"s:14DiscogsService10OperationsO19GetPriceSuggestionsO5InputV","kind":"typeIdentifier"},{"text":".","kind":"text"},{"text":"Headers","preciseIdentifier":"s:14DiscogsService10OperationsO19GetPriceSuggestionsO5InputV7HeadersV","kind":"typeIdentifier"},{"text":") ","kind":"text"},{"text":"async","kind":"keyword"},{"text":" ","kind":"text"},{"text":"throws","kind":"keyword"},{"text":" -> ","kind":"text"},{"text":"Operations","preciseIdentifier":"s:14DiscogsService10OperationsO","kind":"typeIdentifier"},{"text":".","kind":"text"},{"text":"GetPriceSuggestions","preciseIdentifier":"s:14DiscogsService10OperationsO19GetPriceSuggestionsO","kind":"typeIdentifier"},{"text":".","kind":"text"},{"text":"Output","preciseIdentifier":"s:14DiscogsService10OperationsO19GetPriceSuggestionsO6OutputO","kind":"typeIdentifier"}],"role":"symbol"},"references":{"doc://DiscogsService/documentation/DiscogsService/Operations/GetPriceSuggestions/Input/Headers-swift.struct":{"navigatorTitle":[{"kind":"identifier","text":"Headers"}],"kind":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"Headers"}],"title":"Operations.GetPriceSuggestions.Input.Headers","url":"\/documentation\/discogsservice\/operations\/getpricesuggestions\/input\/headers-swift.struct","type":"topic","abstract":[],"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetPriceSuggestions\/Input\/Headers-swift.struct","role":"symbol"},"doc://DiscogsService/documentation/DiscogsService/Client":{"url":"\/documentation\/discogsservice\/client","navigatorTitle":[{"kind":"identifier","text":"Client"}],"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"}]},{"type":"text","text":", "},{"type":"emphasis","inlineContent":[{"type":"text","text":"Releases"}]},{"text":", and ","type":"text"},{"inlineContent":[{"type":"text","text":"Labels"}],"type":"emphasis"},{"text":". Your application can also manage ","type":"text"},{"inlineContent":[{"type":"text","text":"User Collections"}],"type":"emphasis"},{"type":"text","text":" and "},{"type":"emphasis","inlineContent":[{"text":"Wantlists","type":"text"}]},{"type":"text","text":", create "},{"type":"emphasis","inlineContent":[{"type":"text","text":"Marketplace"}]},{"type":"text","text":" listings, and more."}],"title":"Client","kind":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"Client"}],"type":"topic","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Client","role":"symbol"},"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":{"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/Client/getPriceSuggestions(path:headers:)":{"url":"\/documentation\/discogsservice\/client\/getpricesuggestions(path:headers:)","role":"symbol","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Client\/getPriceSuggestions(path:headers:)","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"getPriceSuggestions"},{"kind":"text","text":"("},{"kind":"externalParam","text":"path"},{"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":"Input","preciseIdentifier":"s:14DiscogsService10OperationsO19GetPriceSuggestionsO5InputV"},{"kind":"text","text":"."},{"kind":"typeIdentifier","text":"Path","preciseIdentifier":"s:14DiscogsService10OperationsO19GetPriceSuggestionsO5InputV4PathV"},{"text":", ","kind":"text"},{"text":"headers","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"Operations","preciseIdentifier":"s:14DiscogsService10OperationsO","kind":"typeIdentifier"},{"text":".","kind":"text"},{"text":"GetPriceSuggestions","preciseIdentifier":"s:14DiscogsService10OperationsO19GetPriceSuggestionsO","kind":"typeIdentifier"},{"text":".","kind":"text"},{"text":"Input","preciseIdentifier":"s:14DiscogsService10OperationsO19GetPriceSuggestionsO5InputV","kind":"typeIdentifier"},{"text":".","kind":"text"},{"text":"Headers","preciseIdentifier":"s:14DiscogsService10OperationsO19GetPriceSuggestionsO5InputV7HeadersV","kind":"typeIdentifier"},{"text":") ","kind":"text"},{"text":"async","kind":"keyword"},{"text":" ","kind":"text"},{"text":"throws","kind":"keyword"},{"text":" -> ","kind":"text"},{"text":"Operations","preciseIdentifier":"s:14DiscogsService10OperationsO","kind":"typeIdentifier"},{"text":".","kind":"text"},{"text":"GetPriceSuggestions","preciseIdentifier":"s:14DiscogsService10OperationsO19GetPriceSuggestionsO","kind":"typeIdentifier"},{"text":".","kind":"text"},{"text":"Output","preciseIdentifier":"s:14DiscogsService10OperationsO19GetPriceSuggestionsO6OutputO","kind":"typeIdentifier"}],"abstract":[{"text":"Get some price suggestions for a given release.","type":"text"}],"title":"getPriceSuggestions(path:headers:)","kind":"symbol","type":"topic"},"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/Input/Path-swift.struct":{"title":"Operations.GetPriceSuggestions.Input.Path","type":"topic","url":"\/documentation\/discogsservice\/operations\/getpricesuggestions\/input\/path-swift.struct","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"Path"}],"navigatorTitle":[{"kind":"identifier","text":"Path"}],"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetPriceSuggestions\/Input\/Path-swift.struct","kind":"symbol","abstract":[],"role":"symbol"}}} |