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