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
7.5 KiB
JSON

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