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
6.0 KiB
JSON
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\/Release","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/Release\/CodingKeys"]]},"abstract":[{"type":"text","text":"Creates a new instance with the specified raw value."}],"variants":[{"paths":["\/documentation\/discogsservice\/components\/schemas\/release\/codingkeys\/init(rawvalue:)"],"traits":[{"interfaceLanguage":"swift"}]}],"primaryContentSections":[{"kind":"declarations","declarations":[{"languages":["swift"],"tokens":[{"text":"init","kind":"keyword"},{"text":"?(","kind":"text"},{"text":"rawValue","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":")","kind":"text"}],"platforms":["macOS"]}]},{"kind":"parameters","parameters":[{"name":"rawValue","content":[{"inlineContent":[{"text":"The raw value to use for the new instance.","type":"text"}],"type":"paragraph"}]}]},{"kind":"content","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":" "},{"text":"value, this initializer returns ","type":"text"},{"type":"codeVoice","code":"nil"},{"type":"text","text":". For example:"}]},{"type":"codeListing","syntax":null,"code":["enum PaperSize: String {"," case A4, A5, Letter, Legal","}","","print(PaperSize(rawValue: \"Legal\"))","\/\/ Prints \"Optional(PaperSize.Legal)\"","","print(PaperSize(rawValue: \"Tabloid\"))","\/\/ Prints \"nil\""]}]}],"sections":[],"kind":"symbol","schemaVersion":{"minor":3,"major":0,"patch":0},"identifier":{"url":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/Release\/CodingKeys\/init(rawValue:)","interfaceLanguage":"swift"},"metadata":{"modules":[{"name":"DiscogsService"}],"title":"init(rawValue:)","roleHeading":"Initializer","externalID":"s:14DiscogsService10ComponentsO7SchemasO7ReleaseV10CodingKeysO8rawValueAISgSS_tcfc","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":")"}],"symbolKind":"init","role":"symbol"},"references":{"doc://DiscogsService/documentation/DiscogsService/Components/Schemas/Release":{"url":"\/documentation\/discogsservice\/components\/schemas\/release","navigatorTitle":[{"text":"Release","kind":"identifier"}],"abstract":[{"type":"text","text":"A type that represents a particular physical or digital object released by one or more artists."}],"title":"Components.Schemas.Release","kind":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"text":" ","kind":"text"},{"text":"Release","kind":"identifier"}],"type":"topic","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/Release","role":"symbol"},"doc://DiscogsService/documentation/DiscogsService/Components/Schemas/Release/CodingKeys/init(rawValue:)":{"kind":"symbol","role":"symbol","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/Release\/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"}],"abstract":[{"type":"text","text":"Creates a new instance with the specified raw value."}],"title":"init(rawValue:)","type":"topic","url":"\/documentation\/discogsservice\/components\/schemas\/release\/codingkeys\/init(rawvalue:)"},"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":{"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/Release/CodingKeys":{"url":"\/documentation\/discogsservice\/components\/schemas\/release\/codingkeys","navigatorTitle":[{"text":"CodingKeys","kind":"identifier"}],"abstract":[],"title":"Components.Schemas.Release.CodingKeys","kind":"symbol","fragments":[{"kind":"keyword","text":"enum"},{"text":" ","kind":"text"},{"kind":"identifier","text":"CodingKeys"}],"type":"topic","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/Release\/CodingKeys","role":"symbol"},"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"}}} |