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.2 KiB
JSON
1 line
7.2 KiB
JSON
{"hierarchy":{"paths":[["doc:\/\/DiscogsService\/documentation\/DiscogsService","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetUserProfile","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetUserProfile\/Output"]]},"kind":"symbol","sections":[],"variants":[{"paths":["\/documentation\/discogsservice\/operations\/getuserprofile\/output\/ok(_:)"],"traits":[{"interfaceLanguage":"swift"}]}],"schemaVersion":{"major":0,"patch":0,"minor":3},"abstract":[{"text":"Successfully retrieved profile user information by a given username.","type":"text"}],"metadata":{"roleHeading":"Case","symbolKind":"case","modules":[{"name":"DiscogsService"}],"fragments":[{"text":"case","kind":"keyword"},{"text":" ","kind":"text"},{"text":"ok","kind":"identifier"},{"text":"(","kind":"text"},{"text":"Operations","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO"},{"text":".","kind":"text"},{"text":"GetUserProfile","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO14GetUserProfileO"},{"text":".","kind":"text"},{"text":"Output","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO14GetUserProfileO6OutputO"},{"text":".","kind":"text"},{"text":"Ok","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO14GetUserProfileO6OutputO2OkV"},{"text":")","kind":"text"}],"title":"Operations.GetUserProfile.Output.ok(_:)","externalID":"s:14DiscogsService10OperationsO14GetUserProfileO6OutputO2okyA2G2OkVcAGmF","role":"symbol"},"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetUserProfile\/Output\/ok(_:)"},"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"text":"case","kind":"keyword"},{"text":" ","kind":"text"},{"text":"ok","kind":"identifier"},{"text":"(","kind":"text"},{"preciseIdentifier":"s:14DiscogsService10OperationsO","text":"Operations","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations","kind":"typeIdentifier"},{"text":".","kind":"text"},{"preciseIdentifier":"s:14DiscogsService10OperationsO14GetUserProfileO","text":"GetUserProfile","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetUserProfile","kind":"typeIdentifier"},{"text":".","kind":"text"},{"preciseIdentifier":"s:14DiscogsService10OperationsO14GetUserProfileO6OutputO","text":"Output","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetUserProfile\/Output","kind":"typeIdentifier"},{"text":".","kind":"text"},{"preciseIdentifier":"s:14DiscogsService10OperationsO14GetUserProfileO6OutputO2OkV","text":"Ok","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetUserProfile\/Output\/Ok-swift.struct","kind":"typeIdentifier"},{"text":")","kind":"text"}],"languages":["swift"],"platforms":["macOS"]}]},{"content":[{"text":"Discussion","anchor":"discussion","level":2,"type":"heading"},{"style":"note","name":"Remark","content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"Generated from "},{"type":"codeVoice","code":"#\/paths\/\/users\/{username}\/get(getUserProfile)\/responses\/200"},{"text":".","type":"text"}]}],"type":"aside"},{"inlineContent":[{"text":"HTTP response code: ","type":"text"},{"type":"codeVoice","code":"200 ok"},{"type":"text","text":"."}],"type":"paragraph"}],"kind":"content"}],"references":{"doc://DiscogsService/documentation/DiscogsService/Operations/GetUserProfile":{"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetUserProfile","title":"Operations.GetUserProfile","url":"\/documentation\/discogsservice\/operations\/getuserprofile","type":"topic","abstract":[{"text":"Get information about a user.","type":"text"}],"kind":"symbol","role":"symbol","fragments":[{"kind":"keyword","text":"enum"},{"kind":"text","text":" "},{"kind":"identifier","text":"GetUserProfile"}],"navigatorTitle":[{"kind":"identifier","text":"GetUserProfile"}]},"doc://DiscogsService/documentation/DiscogsService/Operations/GetUserProfile/Output/ok(_:)":{"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetUserProfile\/Output\/ok(_:)","abstract":[{"text":"Successfully retrieved profile user information by a given username.","type":"text"}],"type":"topic","title":"Operations.GetUserProfile.Output.ok(_:)","fragments":[{"kind":"keyword","text":"case"},{"kind":"text","text":" "},{"kind":"identifier","text":"ok"},{"kind":"text","text":"("},{"kind":"typeIdentifier","text":"Operations","preciseIdentifier":"s:14DiscogsService10OperationsO"},{"kind":"text","text":"."},{"kind":"typeIdentifier","text":"GetUserProfile","preciseIdentifier":"s:14DiscogsService10OperationsO14GetUserProfileO"},{"kind":"text","text":"."},{"kind":"typeIdentifier","text":"Output","preciseIdentifier":"s:14DiscogsService10OperationsO14GetUserProfileO6OutputO"},{"kind":"text","text":"."},{"kind":"typeIdentifier","text":"Ok","preciseIdentifier":"s:14DiscogsService10OperationsO14GetUserProfileO6OutputO2OkV"},{"kind":"text","text":")"}],"kind":"symbol","role":"symbol","url":"\/documentation\/discogsservice\/operations\/getuserprofile\/output\/ok(_:)"},"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/GetUserProfile/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.GetUserProfile.Output","url":"\/documentation\/discogsservice\/operations\/getuserprofile\/output","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetUserProfile\/Output"},"doc://DiscogsService/documentation/DiscogsService/Operations/GetUserProfile/Output/Ok-swift.struct":{"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetUserProfile\/Output\/Ok-swift.struct","kind":"symbol","role":"symbol","type":"topic","title":"Operations.GetUserProfile.Output.Ok","abstract":[],"url":"\/documentation\/discogsservice\/operations\/getuserprofile\/output\/ok-swift.struct","navigatorTitle":[{"kind":"identifier","text":"Ok"}],"fragments":[{"text":"struct","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"Ok"}]},"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."}]}}} |