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