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

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