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

{"schemaVersion":{"patch":0,"minor":3,"major":0},"hierarchy":{"paths":[["doc:\/\/DiscogsService\/documentation\/DiscogsService","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/UserIdentity"]]},"kind":"symbol","sections":[],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/discogsservice\/components\/schemas\/useridentity\/value2payload"]}],"topicSections":[{"title":"Initializers","generated":true,"anchor":"Initializers","identifiers":["doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/UserIdentity\/Value2Payload\/init(consumerName:)","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/UserIdentity\/Value2Payload\/init(from:)"]},{"title":"Instance Properties","generated":true,"anchor":"Instance-Properties","identifiers":["doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/UserIdentity\/Value2Payload\/consumerName"]},{"title":"Enumerations","generated":true,"anchor":"Enumerations","identifiers":["doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/UserIdentity\/Value2Payload\/CodingKeys"]},{"title":"Default Implementations","generated":true,"anchor":"Default-Implementations","identifiers":["doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/UserIdentity\/Value2Payload\/Equatable-Implementations"]}],"relationshipsSections":[{"type":"conformsTo","kind":"relationships","title":"Conforms To","identifiers":["doc:\/\/DiscogsService\/Se","doc:\/\/DiscogsService\/SE","doc:\/\/DiscogsService\/SQ","doc:\/\/DiscogsService\/SH","doc:\/\/DiscogsService\/s8SendableP","doc:\/\/DiscogsService\/s16SendableMetatypeP"]}],"metadata":{"symbolKind":"struct","role":"symbol","title":"Components.Schemas.UserIdentity.Value2Payload","modules":[{"name":"DiscogsService"}],"externalID":"s:14DiscogsService10ComponentsO7SchemasO12UserIdentityV13Value2PayloadV","roleHeading":"Structure","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Value2Payload","kind":"identifier"}],"navigatorTitle":[{"kind":"identifier","text":"Value2Payload"}]},"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/UserIdentity\/Value2Payload"},"primaryContentSections":[{"kind":"declarations","declarations":[{"languages":["swift"],"tokens":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"Value2Payload"}],"platforms":["macOS"]}]},{"kind":"content","content":[{"type":"heading","level":2,"text":"Overview","anchor":"overview"},{"type":"aside","content":[{"type":"paragraph","inlineContent":[{"text":"Generated from ","type":"text"},{"code":"#\/components\/schemas\/UserIdentity\/value2","type":"codeVoice"},{"text":".","type":"text"}]}],"style":"note","name":"Remark"}]}],"references":{"doc://DiscogsService/SE":{"title":"Swift.Encodable","identifier":"doc:\/\/DiscogsService\/SE","type":"unresolvable"},"doc://DiscogsService/documentation/DiscogsService/Components/Schemas/UserIdentity/Value2Payload/init(consumerName:)":{"type":"topic","role":"symbol","fragments":[{"text":"init","kind":"identifier"},{"text":"(","kind":"text"},{"text":"consumerName","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":"?)","kind":"text"}],"kind":"symbol","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/UserIdentity\/Value2Payload\/init(consumerName:)","abstract":[{"text":"Creates a new ","type":"text"},{"type":"codeVoice","code":"Value2Payload"},{"text":".","type":"text"}],"url":"\/documentation\/discogsservice\/components\/schemas\/useridentity\/value2payload\/init(consumername:)","title":"init(consumerName:)"},"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/Value2Payload/init(from:)":{"abstract":[{"type":"text","text":"Creates a new instance by decoding from the given decoder."}],"url":"\/documentation\/discogsservice\/components\/schemas\/useridentity\/value2payload\/init(from:)","kind":"symbol","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/UserIdentity\/Value2Payload\/init(from:)","fragments":[{"text":"init","kind":"identifier"},{"text":"(","kind":"text"},{"text":"from","kind":"externalParam"},{"text":": any ","kind":"text"},{"text":"Decoder","kind":"typeIdentifier","preciseIdentifier":"s:s7DecoderP"},{"text":") ","kind":"text"},{"text":"throws","kind":"keyword"}],"role":"symbol","title":"init(from:)","type":"topic"},"doc://DiscogsService/documentation/DiscogsService/Components/Schemas/UserIdentity/Value2Payload/Equatable-Implementations":{"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/UserIdentity\/Value2Payload\/Equatable-Implementations","url":"\/documentation\/discogsservice\/components\/schemas\/useridentity\/value2payload\/equatable-implementations","title":"Equatable Implementations","type":"topic","role":"collectionGroup","abstract":[],"kind":"article"},"doc://DiscogsService/documentation/DiscogsService/Components/Schemas/UserIdentity/Value2Payload/consumerName":{"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/UserIdentity\/Value2Payload\/consumerName","title":"consumerName","url":"\/documentation\/discogsservice\/components\/schemas\/useridentity\/value2payload\/consumername","type":"topic","abstract":[{"type":"text","text":"A name of an application a user utilizes to interact with the service."}],"kind":"symbol","role":"symbol","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"consumerName"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":"?"}]},"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"},"doc://DiscogsService/Se":{"title":"Swift.Decodable","identifier":"doc:\/\/DiscogsService\/Se","type":"unresolvable"},"doc://DiscogsService/s8SendableP":{"identifier":"doc:\/\/DiscogsService\/s8SendableP","title":"Swift.Sendable","type":"unresolvable"},"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/Components/Schemas/UserIdentity/Value2Payload":{"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/UserIdentity\/Value2Payload","title":"Components.Schemas.UserIdentity.Value2Payload","url":"\/documentation\/discogsservice\/components\/schemas\/useridentity\/value2payload","type":"topic","abstract":[],"kind":"symbol","role":"symbol","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Value2Payload","kind":"identifier"}],"navigatorTitle":[{"text":"Value2Payload","kind":"identifier"}]},"doc://DiscogsService/documentation/DiscogsService/Components/Schemas/UserIdentity/Value2Payload/CodingKeys":{"title":"Components.Schemas.UserIdentity.Value2Payload.CodingKeys","type":"topic","url":"\/documentation\/discogsservice\/components\/schemas\/useridentity\/value2payload\/codingkeys","fragments":[{"text":"enum","kind":"keyword"},{"text":" ","kind":"text"},{"text":"CodingKeys","kind":"identifier"}],"navigatorTitle":[{"text":"CodingKeys","kind":"identifier"}],"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/UserIdentity\/Value2Payload\/CodingKeys","kind":"symbol","abstract":[],"role":"symbol"},"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/s16SendableMetatypeP":{"title":"Swift.SendableMetatype","identifier":"doc:\/\/DiscogsService\/s16SendableMetatypeP","type":"unresolvable"},"doc://DiscogsService/SH":{"identifier":"doc:\/\/DiscogsService\/SH","title":"Swift.Hashable","type":"unresolvable"},"doc://DiscogsService/SQ":{"title":"Swift.Equatable","identifier":"doc:\/\/DiscogsService\/SQ","type":"unresolvable"}}}