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
12 KiB
JSON
1 line
12 KiB
JSON
{"variants":[{"paths":["\/documentation\/discogsservice\/operations\/getuseridentity\/output\/ok-swift.struct\/init(headers:body:)"],"traits":[{"interfaceLanguage":"swift"}]}],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetUserIdentity\/Output\/Ok-swift.struct\/init(headers:body:)"},"kind":"symbol","schemaVersion":{"minor":3,"major":0,"patch":0},"hierarchy":{"paths":[["doc:\/\/DiscogsService\/documentation\/DiscogsService","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetUserIdentity","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetUserIdentity\/Output","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetUserIdentity\/Output\/Ok-swift.struct"]]},"primaryContentSections":[{"kind":"declarations","declarations":[{"languages":["swift"],"tokens":[{"kind":"keyword","text":"init"},{"kind":"text","text":"("},{"text":"headers","kind":"externalParam"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO","text":"Operations","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations"},{"kind":"text","text":"."},{"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetUserIdentity","preciseIdentifier":"s:14DiscogsService10OperationsO15GetUserIdentityO","text":"GetUserIdentity","kind":"typeIdentifier"},{"kind":"text","text":"."},{"preciseIdentifier":"s:14DiscogsService10OperationsO15GetUserIdentityO6OutputO","kind":"typeIdentifier","text":"Output","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetUserIdentity\/Output"},{"kind":"text","text":"."},{"preciseIdentifier":"s:14DiscogsService10OperationsO15GetUserIdentityO6OutputO2OkV","kind":"typeIdentifier","text":"Ok","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetUserIdentity\/Output\/Ok-swift.struct"},{"kind":"text","text":"."},{"preciseIdentifier":"s:14DiscogsService10OperationsO15GetUserIdentityO6OutputO2OkV7HeadersV","kind":"typeIdentifier","text":"Headers","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetUserIdentity\/Output\/Ok-swift.struct\/Headers-swift.struct"},{"kind":"text","text":", "},{"kind":"externalParam","text":"body"},{"kind":"text","text":": "},{"preciseIdentifier":"s:14DiscogsService10OperationsO","kind":"typeIdentifier","text":"Operations","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations"},{"kind":"text","text":"."},{"preciseIdentifier":"s:14DiscogsService10OperationsO15GetUserIdentityO","text":"GetUserIdentity","kind":"typeIdentifier","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetUserIdentity"},{"text":".","kind":"text"},{"preciseIdentifier":"s:14DiscogsService10OperationsO15GetUserIdentityO6OutputO","text":"Output","kind":"typeIdentifier","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetUserIdentity\/Output"},{"text":".","kind":"text"},{"preciseIdentifier":"s:14DiscogsService10OperationsO15GetUserIdentityO6OutputO2OkV","text":"Ok","kind":"typeIdentifier","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetUserIdentity\/Output\/Ok-swift.struct"},{"text":".","kind":"text"},{"text":"Body","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetUserIdentity\/Output\/Ok-swift.struct\/Body-swift.enum","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO15GetUserIdentityO6OutputO2OkV4BodyO"},{"text":")","kind":"text"}],"platforms":["macOS"]}]},{"kind":"parameters","parameters":[{"name":"headers","content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"Received HTTP response headers"}]}]},{"content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"Received HTTP response body"}]}],"name":"body"}]}],"metadata":{"fragments":[{"text":"init","kind":"identifier"},{"kind":"text","text":"("},{"kind":"externalParam","text":"headers"},{"kind":"text","text":": "},{"preciseIdentifier":"s:14DiscogsService10OperationsO","kind":"typeIdentifier","text":"Operations"},{"kind":"text","text":"."},{"kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO15GetUserIdentityO","text":"GetUserIdentity"},{"kind":"text","text":"."},{"text":"Output","preciseIdentifier":"s:14DiscogsService10OperationsO15GetUserIdentityO6OutputO","kind":"typeIdentifier"},{"text":".","kind":"text"},{"text":"Ok","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO15GetUserIdentityO6OutputO2OkV"},{"kind":"text","text":"."},{"kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO15GetUserIdentityO6OutputO2OkV7HeadersV","text":"Headers"},{"kind":"text","text":", "},{"kind":"externalParam","text":"body"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:14DiscogsService10OperationsO","text":"Operations","kind":"typeIdentifier"},{"text":".","kind":"text"},{"text":"GetUserIdentity","preciseIdentifier":"s:14DiscogsService10OperationsO15GetUserIdentityO","kind":"typeIdentifier"},{"text":".","kind":"text"},{"text":"Output","preciseIdentifier":"s:14DiscogsService10OperationsO15GetUserIdentityO6OutputO","kind":"typeIdentifier"},{"text":".","kind":"text"},{"text":"Ok","preciseIdentifier":"s:14DiscogsService10OperationsO15GetUserIdentityO6OutputO2OkV","kind":"typeIdentifier"},{"text":".","kind":"text"},{"text":"Body","preciseIdentifier":"s:14DiscogsService10OperationsO15GetUserIdentityO6OutputO2OkV4BodyO","kind":"typeIdentifier"},{"text":")","kind":"text"}],"roleHeading":"Initializer","role":"symbol","modules":[{"name":"DiscogsService"}],"title":"init(headers:body:)","symbolKind":"init","externalID":"s:14DiscogsService10OperationsO15GetUserIdentityO6OutputO2OkV7headers4bodyA2I7HeadersV_AI4BodyOtcfc"},"sections":[],"abstract":[{"type":"text","text":"Creates a new "},{"type":"codeVoice","code":"Ok"},{"type":"text","text":"."}],"references":{"doc://DiscogsService/documentation/DiscogsService/Operations":{"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations","title":"Operations","type":"topic","url":"\/documentation\/discogsservice\/operations","abstract":[{"type":"text","text":"API operations, with input and output types, generated from "},{"type":"codeVoice","code":"#\/paths"},{"text":" in the OpenAPI document.","type":"text"}],"kind":"symbol","role":"symbol","fragments":[{"kind":"keyword","text":"enum"},{"kind":"text","text":" "},{"kind":"identifier","text":"Operations"}],"navigatorTitle":[{"kind":"identifier","text":"Operations"}]},"doc://DiscogsService/documentation/DiscogsService/Operations/GetUserIdentity/Output/Ok-swift.struct/init(headers:body:)":{"url":"\/documentation\/discogsservice\/operations\/getuseridentity\/output\/ok-swift.struct\/init(headers:body:)","title":"init(headers:body:)","role":"symbol","fragments":[{"text":"init","kind":"identifier"},{"text":"(","kind":"text"},{"text":"headers","kind":"externalParam"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","text":"Operations","preciseIdentifier":"s:14DiscogsService10OperationsO"},{"kind":"text","text":"."},{"kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO15GetUserIdentityO","text":"GetUserIdentity"},{"kind":"text","text":"."},{"kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO15GetUserIdentityO6OutputO","text":"Output"},{"kind":"text","text":"."},{"kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO15GetUserIdentityO6OutputO2OkV","text":"Ok"},{"text":".","kind":"text"},{"text":"Headers","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO15GetUserIdentityO6OutputO2OkV7HeadersV"},{"text":", ","kind":"text"},{"text":"body","kind":"externalParam"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO","text":"Operations"},{"text":".","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO15GetUserIdentityO","text":"GetUserIdentity"},{"text":".","kind":"text"},{"preciseIdentifier":"s:14DiscogsService10OperationsO15GetUserIdentityO6OutputO","text":"Output","kind":"typeIdentifier"},{"kind":"text","text":"."},{"kind":"typeIdentifier","text":"Ok","preciseIdentifier":"s:14DiscogsService10OperationsO15GetUserIdentityO6OutputO2OkV"},{"text":".","kind":"text"},{"kind":"typeIdentifier","text":"Body","preciseIdentifier":"s:14DiscogsService10OperationsO15GetUserIdentityO6OutputO2OkV4BodyO"},{"text":")","kind":"text"}],"abstract":[{"text":"Creates a new ","type":"text"},{"type":"codeVoice","code":"Ok"},{"text":".","type":"text"}],"kind":"symbol","type":"topic","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetUserIdentity\/Output\/Ok-swift.struct\/init(headers:body:)"},"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/GetUserIdentity/Output/Ok-swift.struct/Body-swift.enum":{"navigatorTitle":[{"text":"Body","kind":"identifier"}],"kind":"symbol","fragments":[{"text":"enum","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Body","kind":"identifier"}],"title":"Operations.GetUserIdentity.Output.Ok.Body","url":"\/documentation\/discogsservice\/operations\/getuseridentity\/output\/ok-swift.struct\/body-swift.enum","abstract":[],"type":"topic","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetUserIdentity\/Output\/Ok-swift.struct\/Body-swift.enum","role":"symbol"},"doc://DiscogsService/documentation/DiscogsService/Operations/GetUserIdentity/Output":{"fragments":[{"text":"enum","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Output","kind":"identifier"}],"navigatorTitle":[{"text":"Output","kind":"identifier"}],"role":"symbol","type":"topic","kind":"symbol","title":"Operations.GetUserIdentity.Output","url":"\/documentation\/discogsservice\/operations\/getuseridentity\/output","abstract":[],"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetUserIdentity\/Output"},"doc://DiscogsService/documentation/DiscogsService/Operations/GetUserIdentity":{"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetUserIdentity","title":"Operations.GetUserIdentity","url":"\/documentation\/discogsservice\/operations\/getuseridentity","type":"topic","abstract":[{"type":"text","text":"Get information about an authenticated user."}],"kind":"symbol","role":"symbol","fragments":[{"kind":"keyword","text":"enum"},{"text":" ","kind":"text"},{"kind":"identifier","text":"GetUserIdentity"}],"navigatorTitle":[{"text":"GetUserIdentity","kind":"identifier"}]},"doc://DiscogsService/documentation/DiscogsService/Operations/GetUserIdentity/Output/Ok-swift.struct":{"abstract":[],"url":"\/documentation\/discogsservice\/operations\/getuseridentity\/output\/ok-swift.struct","kind":"symbol","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetUserIdentity\/Output\/Ok-swift.struct","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"Ok"}],"navigatorTitle":[{"text":"Ok","kind":"identifier"}],"role":"symbol","title":"Operations.GetUserIdentity.Output.Ok","type":"topic"},"doc://DiscogsService/documentation/DiscogsService/Operations/GetUserIdentity/Output/Ok-swift.struct/Headers-swift.struct":{"type":"topic","url":"\/documentation\/discogsservice\/operations\/getuseridentity\/output\/ok-swift.struct\/headers-swift.struct","navigatorTitle":[{"text":"Headers","kind":"identifier"}],"role":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"text":"Headers","kind":"identifier"}],"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetUserIdentity\/Output\/Ok-swift.struct\/Headers-swift.struct","abstract":[],"kind":"symbol","title":"Operations.GetUserIdentity.Output.Ok.Headers"}}} |