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
6.9 KiB
JSON
1 line
6.9 KiB
JSON
{"sections":[],"primaryContentSections":[{"kind":"declarations","declarations":[{"platforms":["macOS"],"languages":["swift"],"tokens":[{"text":"enum","kind":"keyword"},{"text":" ","kind":"text"},{"text":"GetUserProfile","kind":"identifier"}]}]},{"content":[{"anchor":"overview","level":2,"type":"heading","text":"Overview"},{"type":"paragraph","inlineContent":[{"type":"text","text":"Retrieves a user profile by username."}]},{"type":"paragraph","inlineContent":[{"text":"In case of being authenticated as the requested user, the ","type":"text"},{"type":"codeVoice","code":"email"},{"text":" property will be visible, and the ","type":"text"},{"type":"codeVoice","code":"num_list"},{"text":" count will also include a user’s private lists.","type":"text"}]},{"type":"paragraph","inlineContent":[{"type":"text","text":"In case of being authenticated as the requested user, or a user’s collection or wantlist is public, the "},{"type":"codeVoice","code":"num_collection"},{"type":"text","text":" and the "},{"type":"codeVoice","code":"num_wantlist"},{"type":"text","text":" properties will also be visible."}]},{"type":"aside","name":"Remark","content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"HTTP "},{"type":"codeVoice","code":"GET \/users\/{username}"},{"type":"text","text":"."}]}],"style":"note"},{"type":"aside","name":"Remark","content":[{"inlineContent":[{"type":"text","text":"Generated from "},{"type":"codeVoice","code":"#\/paths\/\/users\/{username}\/get(getUserProfile)"},{"type":"text","text":"."}],"type":"paragraph"}],"style":"note"}],"kind":"content"}],"topicSections":[{"identifiers":["doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetUserProfile\/Input"],"anchor":"Structures","title":"Structures","generated":true},{"generated":true,"identifiers":["doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetUserProfile\/id"],"anchor":"Type-Properties","title":"Type Properties"},{"generated":true,"identifiers":["doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetUserProfile\/AcceptableContentType","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetUserProfile\/Output"],"anchor":"Enumerations","title":"Enumerations"}],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetUserProfile"},"variants":[{"paths":["\/documentation\/discogsservice\/operations\/getuserprofile"],"traits":[{"interfaceLanguage":"swift"}]}],"schemaVersion":{"minor":3,"major":0,"patch":0},"abstract":[{"text":"Get information about a user.","type":"text"}],"kind":"symbol","hierarchy":{"paths":[["doc:\/\/DiscogsService\/documentation\/DiscogsService","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations"]]},"metadata":{"roleHeading":"Enumeration","externalID":"s:14DiscogsService10OperationsO14GetUserProfileO","modules":[{"name":"DiscogsService"}],"title":"Operations.GetUserProfile","navigatorTitle":[{"kind":"identifier","text":"GetUserProfile"}],"symbolKind":"enum","fragments":[{"kind":"keyword","text":"enum"},{"kind":"text","text":" "},{"kind":"identifier","text":"GetUserProfile"}],"role":"symbol"},"references":{"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":{"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":{"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":{"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/GetUserProfile/id":{"type":"topic","title":"id","abstract":[],"role":"symbol","fragments":[{"text":"static","kind":"keyword"},{"text":" ","kind":"text"},{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"id","kind":"identifier"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"}],"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetUserProfile\/id","url":"\/documentation\/discogsservice\/operations\/getuserprofile\/id","kind":"symbol"},"doc://DiscogsService/documentation/DiscogsService/Operations/GetUserProfile/Input":{"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetUserProfile\/Input","kind":"symbol","role":"symbol","type":"topic","title":"Operations.GetUserProfile.Input","abstract":[],"url":"\/documentation\/discogsservice\/operations\/getuserprofile\/input","navigatorTitle":[{"kind":"identifier","text":"Input"}],"fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"Input"}]},"doc://DiscogsService/documentation/DiscogsService/Operations/GetUserProfile/AcceptableContentType":{"navigatorTitle":[{"text":"AcceptableContentType","kind":"identifier"}],"kind":"symbol","fragments":[{"text":"enum","kind":"keyword"},{"text":" ","kind":"text"},{"text":"AcceptableContentType","kind":"identifier"}],"title":"Operations.GetUserProfile.AcceptableContentType","url":"\/documentation\/discogsservice\/operations\/getuserprofile\/acceptablecontenttype","type":"topic","abstract":[],"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetUserProfile\/AcceptableContentType","role":"symbol"}}} |