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

{"schemaVersion":{"patch":0,"major":0,"minor":3},"hierarchy":{"paths":[["doc:\/\/DiscogsService\/documentation\/DiscogsService","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/UserIdentity"]]},"primaryContentSections":[{"declarations":[{"platforms":["macOS"],"languages":["swift"],"tokens":[{"kind":"keyword","text":"init"},{"kind":"text","text":"("},{"kind":"externalParam","text":"from"},{"kind":"text","text":" "},{"kind":"internalParam","text":"decoder"},{"kind":"text","text":": any "},{"preciseIdentifier":"s:s7DecoderP","kind":"typeIdentifier","text":"Decoder"},{"kind":"text","text":") "},{"kind":"keyword","text":"throws"}]}],"kind":"declarations"},{"kind":"parameters","parameters":[{"name":"decoder","content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"The decoder to read data from."}]}]}]},{"kind":"content","content":[{"anchor":"discussion","type":"heading","level":2,"text":"Discussion"},{"type":"paragraph","inlineContent":[{"text":"This initializer throws an error if reading from the decoder fails, or","type":"text"},{"text":" ","type":"text"},{"text":"if the data read is corrupted or otherwise invalid.","type":"text"}]}]}],"sections":[],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/UserIdentity\/init(from:)"},"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/discogsservice\/components\/schemas\/useridentity\/init(from:)"]}],"kind":"symbol","metadata":{"externalID":"s:14DiscogsService10ComponentsO7SchemasO12UserIdentityV4fromAGs7Decoder_p_tKcfc","modules":[{"name":"DiscogsService"}],"roleHeading":"Initializer","role":"symbol","fragments":[{"kind":"identifier","text":"init"},{"kind":"text","text":"("},{"kind":"externalParam","text":"from"},{"kind":"text","text":": any "},{"preciseIdentifier":"s:s7DecoderP","kind":"typeIdentifier","text":"Decoder"},{"kind":"text","text":") "},{"kind":"keyword","text":"throws"}],"title":"init(from:)","symbolKind":"init"},"abstract":[{"type":"text","text":"Creates a new instance by decoding from the given decoder."}],"references":{"doc://DiscogsService/documentation/DiscogsService/Components/Schemas/UserIdentity/init(from:)":{"url":"\/documentation\/discogsservice\/components\/schemas\/useridentity\/init(from:)","kind":"symbol","role":"symbol","fragments":[{"text":"init","kind":"identifier"},{"text":"(","kind":"text"},{"text":"from","kind":"externalParam"},{"text":": any ","kind":"text"},{"text":"Decoder","preciseIdentifier":"s:s7DecoderP","kind":"typeIdentifier"},{"text":") ","kind":"text"},{"text":"throws","kind":"keyword"}],"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/UserIdentity\/init(from:)","abstract":[{"text":"Creates a new instance by decoding from the given decoder.","type":"text"}],"type":"topic","title":"init(from:)"},"doc://DiscogsService/documentation/DiscogsService/Components/Schemas":{"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas","kind":"symbol","role":"symbol","type":"topic","title":"Components.Schemas","abstract":[{"type":"text","text":"Types generated from the "},{"code":"#\/components\/schemas","type":"codeVoice"},{"text":" section of the OpenAPI document.","type":"text"}],"url":"\/documentation\/discogsservice\/components\/schemas","navigatorTitle":[{"kind":"identifier","text":"Schemas"}],"fragments":[{"text":"enum","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"Schemas"}]},"doc://DiscogsService/documentation/DiscogsService/Components":{"fragments":[{"kind":"keyword","text":"enum"},{"text":" ","kind":"text"},{"kind":"identifier","text":"Components"}],"type":"topic","navigatorTitle":[{"kind":"identifier","text":"Components"}],"role":"symbol","kind":"symbol","abstract":[{"text":"Types generated from the components section of the OpenAPI document.","type":"text"}],"title":"Components","url":"\/documentation\/discogsservice\/components","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components"},"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/Components/Schemas/UserIdentity":{"fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"UserIdentity"}],"kind":"symbol","role":"symbol","abstract":[{"type":"text","text":"A type that represents a user identity."}],"type":"topic","url":"\/documentation\/discogsservice\/components\/schemas\/useridentity","title":"Components.Schemas.UserIdentity","navigatorTitle":[{"kind":"identifier","text":"UserIdentity"}],"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/UserIdentity"}}}