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

{"hierarchy":{"paths":[["doc:\/\/DiscogsService\/documentation\/DiscogsService","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/Identifier","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/Identifier\/CodingKeys"]]},"primaryContentSections":[{"declarations":[{"languages":["swift"],"tokens":[{"text":"init","kind":"keyword"},{"text":"?(","kind":"text"},{"text":"rawValue","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":")","kind":"text"}],"platforms":["macOS"]}],"kind":"declarations"},{"kind":"parameters","parameters":[{"name":"rawValue","content":[{"inlineContent":[{"type":"text","text":"The raw value to use for the new instance."}],"type":"paragraph"}]}]},{"kind":"content","content":[{"text":"Discussion","anchor":"discussion","type":"heading","level":2},{"type":"paragraph","inlineContent":[{"text":"If there is no value of the type that corresponds with the specified raw","type":"text"},{"text":" ","type":"text"},{"text":"value, this initializer returns ","type":"text"},{"code":"nil","type":"codeVoice"},{"text":". For example:","type":"text"}]},{"code":["enum PaperSize: String {"," case A4, A5, Letter, Legal","}","","print(PaperSize(rawValue: \"Legal\"))","\/\/ Prints \"Optional(PaperSize.Legal)\"","","print(PaperSize(rawValue: \"Tabloid\"))","\/\/ Prints \"nil\""],"syntax":null,"type":"codeListing"}]}],"identifier":{"url":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/Identifier\/CodingKeys\/init(rawValue:)","interfaceLanguage":"swift"},"sections":[],"schemaVersion":{"major":0,"patch":0,"minor":3},"kind":"symbol","abstract":[{"text":"Creates a new instance with the specified raw value.","type":"text"}],"variants":[{"paths":["\/documentation\/discogsservice\/components\/schemas\/identifier\/codingkeys\/init(rawvalue:)"],"traits":[{"interfaceLanguage":"swift"}]}],"metadata":{"title":"init(rawValue:)","symbolKind":"init","roleHeading":"Initializer","fragments":[{"kind":"identifier","text":"init"},{"kind":"text","text":"?("},{"kind":"externalParam","text":"rawValue"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":")"}],"modules":[{"name":"DiscogsService"}],"role":"symbol","externalID":"s:14DiscogsService10ComponentsO7SchemasO10IdentifierV10CodingKeysO8rawValueAISgSS_tcfc"},"references":{"doc://DiscogsService/documentation/DiscogsService/Components/Schemas/Identifier/CodingKeys":{"fragments":[{"kind":"keyword","text":"enum"},{"kind":"text","text":" "},{"kind":"identifier","text":"CodingKeys"}],"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/Identifier\/CodingKeys","type":"topic","role":"symbol","title":"Components.Schemas.Identifier.CodingKeys","kind":"symbol","abstract":[],"navigatorTitle":[{"kind":"identifier","text":"CodingKeys"}],"url":"\/documentation\/discogsservice\/components\/schemas\/identifier\/codingkeys"},"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/Identifier/CodingKeys/init(rawValue:)":{"role":"symbol","url":"\/documentation\/discogsservice\/components\/schemas\/identifier\/codingkeys\/init(rawvalue:)","kind":"symbol","title":"init(rawValue:)","abstract":[{"text":"Creates a new instance with the specified raw value.","type":"text"}],"fragments":[{"text":"init","kind":"identifier"},{"text":"?(","kind":"text"},{"text":"rawValue","kind":"externalParam"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":")"}],"type":"topic","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/Identifier\/CodingKeys\/init(rawValue:)"},"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/Identifier":{"fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Identifier","kind":"identifier"}],"type":"topic","navigatorTitle":[{"text":"Identifier","kind":"identifier"}],"role":"symbol","kind":"symbol","abstract":[{"type":"text","text":"A type that represents an identifier."}],"title":"Components.Schemas.Identifier","url":"\/documentation\/discogsservice\/components\/schemas\/identifier","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/Identifier"},"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"}]}}}