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
7.7 KiB
JSON
1 line
7.7 KiB
JSON
{"sections":[],"primaryContentSections":[{"declarations":[{"tokens":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"ok"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Operations","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations","preciseIdentifier":"s:14DiscogsService10OperationsO"},{"kind":"text","text":"."},{"kind":"typeIdentifier","text":"GetPriceSuggestions","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetPriceSuggestions","preciseIdentifier":"s:14DiscogsService10OperationsO19GetPriceSuggestionsO"},{"kind":"text","text":"."},{"kind":"typeIdentifier","text":"Output","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetPriceSuggestions\/Output","preciseIdentifier":"s:14DiscogsService10OperationsO19GetPriceSuggestionsO6OutputO"},{"kind":"text","text":"."},{"kind":"typeIdentifier","text":"Ok","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetPriceSuggestions\/Output\/Ok-swift.struct","preciseIdentifier":"s:14DiscogsService10OperationsO19GetPriceSuggestionsO6OutputO2OkV"},{"kind":"text","text":" { "},{"text":"get","kind":"keyword"},{"text":" ","kind":"text"},{"text":"throws","kind":"keyword"},{"text":" }","kind":"text"}],"languages":["swift"],"platforms":["macOS"]}],"kind":"declarations"},{"content":[{"text":"Discussion","anchor":"discussion","type":"heading","level":2},{"content":[{"inlineContent":[{"type":"text","text":"An error if "},{"type":"codeVoice","code":"self"},{"type":"text","text":" is not "},{"type":"codeVoice","code":".ok"},{"type":"text","text":"."}],"type":"paragraph"}],"type":"aside","style":"note","name":"Throws"},{"content":[{"type":"paragraph","inlineContent":[{"type":"text","text":""},{"type":"codeVoice","code":".ok"},{"type":"text","text":"."}]}],"type":"aside","style":"note","name":"See Also"}],"kind":"content"}],"identifier":{"url":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetPriceSuggestions\/Output\/ok-swift.property","interfaceLanguage":"swift"},"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/discogsservice\/operations\/getpricesuggestions\/output\/ok-swift.property"]}],"schemaVersion":{"minor":3,"major":0,"patch":0},"abstract":[{"type":"text","text":"The associated value of the enum case if "},{"code":"self","type":"codeVoice"},{"type":"text","text":" is "},{"code":".ok","type":"codeVoice"},{"type":"text","text":"."}],"hierarchy":{"paths":[["doc:\/\/DiscogsService\/documentation\/DiscogsService","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetPriceSuggestions","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetPriceSuggestions\/Output"]]},"kind":"symbol","metadata":{"roleHeading":"Instance Property","externalID":"s:14DiscogsService10OperationsO19GetPriceSuggestionsO6OutputO2okAG2OkVvp","modules":[{"name":"DiscogsService"}],"title":"ok","symbolKind":"property","fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"ok","kind":"identifier"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO","text":"Operations"},{"kind":"text","text":"."},{"kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO19GetPriceSuggestionsO","text":"GetPriceSuggestions"},{"kind":"text","text":"."},{"kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO19GetPriceSuggestionsO6OutputO","text":"Output"},{"kind":"text","text":"."},{"kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO19GetPriceSuggestionsO6OutputO2OkV","text":"Ok"}],"role":"symbol"},"references":{"doc://DiscogsService/documentation/DiscogsService/Operations/GetPriceSuggestions/Output/ok-swift.property":{"role":"symbol","url":"\/documentation\/discogsservice\/operations\/getpricesuggestions\/output\/ok-swift.property","kind":"symbol","title":"ok","abstract":[{"text":"The associated value of the enum case if ","type":"text"},{"code":"self","type":"codeVoice"},{"text":" is ","type":"text"},{"code":".ok","type":"codeVoice"},{"text":".","type":"text"}],"fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"ok","kind":"identifier"},{"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"},{"text":".","kind":"text"},{"text":"Ok","preciseIdentifier":"s:14DiscogsService10OperationsO19GetPriceSuggestionsO6OutputO2OkV","kind":"typeIdentifier"}],"type":"topic","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetPriceSuggestions\/Output\/ok-swift.property"},"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":{"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/Ok-swift.struct":{"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetPriceSuggestions\/Output\/Ok-swift.struct","title":"Operations.GetPriceSuggestions.Output.Ok","type":"topic","url":"\/documentation\/discogsservice\/operations\/getpricesuggestions\/output\/ok-swift.struct","abstract":[],"kind":"symbol","role":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"Ok"}],"navigatorTitle":[{"kind":"identifier","text":"Ok"}]},"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":{"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"}}} |