d5bd9feb0a
This PR contains the work done to write the main article of the `DocC` documentation for the library, which introduces the library as well as explains how to install it and use it. Reviewed-on: #7 Co-authored-by: Javier Cicchelli <javier@rock-n-code.com> Co-committed-by: Javier Cicchelli <javier@rock-n-code.com>
1 line
11 KiB
JSON
1 line
11 KiB
JSON
{"hierarchy":{"paths":[["doc:\/\/MarvelService\/documentation\/MarvelService","doc:\/\/MarvelService\/documentation\/MarvelService\/Components","doc:\/\/MarvelService\/documentation\/MarvelService\/Components\/Schemas","doc:\/\/MarvelService\/documentation\/MarvelService\/Components\/Schemas\/StorySummary"]]},"identifier":{"url":"doc:\/\/MarvelService\/documentation\/MarvelService\/Components\/Schemas\/StorySummary\/CodingKeys","interfaceLanguage":"swift"},"topicSections":[{"title":"Enumeration Cases","generated":true,"anchor":"Enumeration-Cases","identifiers":["doc:\/\/MarvelService\/documentation\/MarvelService\/Components\/Schemas\/StorySummary\/CodingKeys\/name","doc:\/\/MarvelService\/documentation\/MarvelService\/Components\/Schemas\/StorySummary\/CodingKeys\/resourceURI"]},{"title":"Initializers","generated":true,"anchor":"Initializers","identifiers":["doc:\/\/MarvelService\/documentation\/MarvelService\/Components\/Schemas\/StorySummary\/CodingKeys\/init(intValue:)","doc:\/\/MarvelService\/documentation\/MarvelService\/Components\/Schemas\/StorySummary\/CodingKeys\/init(rawValue:)","doc:\/\/MarvelService\/documentation\/MarvelService\/Components\/Schemas\/StorySummary\/CodingKeys\/init(stringValue:)"]},{"title":"Default Implementations","generated":true,"anchor":"Default-Implementations","identifiers":["doc:\/\/MarvelService\/documentation\/MarvelService\/Components\/Schemas\/StorySummary\/CodingKeys\/CodingKey-Implementations","doc:\/\/MarvelService\/documentation\/MarvelService\/Components\/Schemas\/StorySummary\/CodingKeys\/Equatable-Implementations","doc:\/\/MarvelService\/documentation\/MarvelService\/Components\/Schemas\/StorySummary\/CodingKeys\/RawRepresentable-Implementations"]}],"metadata":{"title":"Components.Schemas.StorySummary.CodingKeys","fragments":[{"kind":"keyword","text":"enum"},{"kind":"text","text":" "},{"kind":"identifier","text":"CodingKeys"}],"role":"symbol","externalID":"s:13MarvelService10ComponentsO7SchemasO12StorySummaryV10CodingKeysO","roleHeading":"Enumeration","symbolKind":"enum","modules":[{"name":"MarvelService"}],"navigatorTitle":[{"text":"CodingKeys","kind":"identifier"}]},"schemaVersion":{"patch":0,"minor":3,"major":0},"kind":"symbol","sections":[],"primaryContentSections":[{"declarations":[{"tokens":[{"kind":"keyword","text":"enum"},{"kind":"text","text":" "},{"kind":"identifier","text":"CodingKeys"}],"platforms":["macOS"],"languages":["swift"]}],"kind":"declarations"}],"variants":[{"paths":["\/documentation\/marvelservice\/components\/schemas\/storysummary\/codingkeys"],"traits":[{"interfaceLanguage":"swift"}]}],"relationshipsSections":[{"type":"conformsTo","identifiers":["doc:\/\/MarvelService\/s9CodingKeyP","doc:\/\/MarvelService\/s28CustomDebugStringConvertibleP","doc:\/\/MarvelService\/s23CustomStringConvertibleP","doc:\/\/MarvelService\/SQ","doc:\/\/MarvelService\/SH","doc:\/\/MarvelService\/SY","doc:\/\/MarvelService\/s8SendableP","doc:\/\/MarvelService\/s16SendableMetatypeP"],"title":"Conforms To","kind":"relationships"}],"references":{"doc://MarvelService/documentation/MarvelService/Components/Schemas/StorySummary/CodingKeys/name":{"identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Components\/Schemas\/StorySummary\/CodingKeys\/name","title":"Components.Schemas.StorySummary.CodingKeys.name","fragments":[{"text":"case","kind":"keyword"},{"text":" ","kind":"text"},{"text":"name","kind":"identifier"}],"kind":"symbol","type":"topic","url":"\/documentation\/marvelservice\/components\/schemas\/storysummary\/codingkeys\/name","role":"symbol","abstract":[]},"doc://MarvelService/documentation/MarvelService":{"identifier":"doc:\/\/MarvelService\/documentation\/MarvelService","kind":"symbol","url":"\/documentation\/marvelservice","title":"MarvelService","role":"collection","abstract":[{"text":"A library that allows the developer to interact with the ","type":"text"},{"type":"strong","inlineContent":[{"text":"Marvel Comics API","type":"text"}]},{"type":"text","text":" backend service."}],"type":"topic"},"doc://MarvelService/documentation/MarvelService/Components/Schemas/StorySummary/CodingKeys/init(intValue:)":{"url":"\/documentation\/marvelservice\/components\/schemas\/storysummary\/codingkeys\/init(intvalue:)","title":"init(intValue:)","type":"topic","abstract":[],"role":"symbol","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Components\/Schemas\/StorySummary\/CodingKeys\/init(intValue:)","kind":"symbol","fragments":[{"text":"init","kind":"identifier"},{"text":"?(","kind":"text"},{"text":"intValue","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:Si","text":"Int","kind":"typeIdentifier"},{"text":")","kind":"text"}]},"doc://MarvelService/s28CustomDebugStringConvertibleP":{"type":"unresolvable","identifier":"doc:\/\/MarvelService\/s28CustomDebugStringConvertibleP","title":"Swift.CustomDebugStringConvertible"},"doc://MarvelService/SH":{"type":"unresolvable","identifier":"doc:\/\/MarvelService\/SH","title":"Swift.Hashable"},"doc://MarvelService/s23CustomStringConvertibleP":{"type":"unresolvable","identifier":"doc:\/\/MarvelService\/s23CustomStringConvertibleP","title":"Swift.CustomStringConvertible"},"doc://MarvelService/documentation/MarvelService/Components/Schemas":{"navigatorTitle":[{"text":"Schemas","kind":"identifier"}],"identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Components\/Schemas","url":"\/documentation\/marvelservice\/components\/schemas","fragments":[{"text":"enum","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Schemas","kind":"identifier"}],"role":"symbol","type":"topic","title":"Components.Schemas","abstract":[{"text":"Types generated from the ","type":"text"},{"code":"#\/components\/schemas","type":"codeVoice"},{"text":" section of the OpenAPI document.","type":"text"}],"kind":"symbol"},"doc://MarvelService/documentation/MarvelService/Components/Schemas/StorySummary":{"title":"Components.Schemas.StorySummary","abstract":[{"type":"text","text":"A type that represents a summary of a story resource."}],"url":"\/documentation\/marvelservice\/components\/schemas\/storysummary","navigatorTitle":[{"text":"StorySummary","kind":"identifier"}],"kind":"symbol","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Components\/Schemas\/StorySummary","type":"topic","role":"symbol","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"StorySummary","kind":"identifier"}]},"doc://MarvelService/SY":{"type":"unresolvable","identifier":"doc:\/\/MarvelService\/SY","title":"Swift.RawRepresentable"},"doc://MarvelService/documentation/MarvelService/Components/Schemas/StorySummary/CodingKeys/init(rawValue:)":{"abstract":[],"role":"symbol","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Components\/Schemas\/StorySummary\/CodingKeys\/init(rawValue:)","title":"init(rawValue:)","fragments":[{"text":"init","kind":"identifier"},{"text":"?(","kind":"text"},{"text":"rawValue","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":")","kind":"text"}],"kind":"symbol","type":"topic","url":"\/documentation\/marvelservice\/components\/schemas\/storysummary\/codingkeys\/init(rawvalue:)"},"doc://MarvelService/documentation/MarvelService/Components/Schemas/StorySummary/CodingKeys/init(stringValue:)":{"title":"init(stringValue:)","abstract":[],"url":"\/documentation\/marvelservice\/components\/schemas\/storysummary\/codingkeys\/init(stringvalue:)","kind":"symbol","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Components\/Schemas\/StorySummary\/CodingKeys\/init(stringValue:)","type":"topic","role":"symbol","fragments":[{"text":"init","kind":"identifier"},{"text":"?(","kind":"text"},{"text":"stringValue","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":")","kind":"text"}]},"doc://MarvelService/documentation/MarvelService/Components":{"navigatorTitle":[{"text":"Components","kind":"identifier"}],"url":"\/documentation\/marvelservice\/components","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Components","fragments":[{"text":"enum","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Components","kind":"identifier"}],"role":"symbol","type":"topic","abstract":[{"text":"Types generated from the components section of the OpenAPI document.","type":"text"}],"title":"Components","kind":"symbol"},"doc://MarvelService/documentation/MarvelService/Components/Schemas/StorySummary/CodingKeys/CodingKey-Implementations":{"identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Components\/Schemas\/StorySummary\/CodingKeys\/CodingKey-Implementations","title":"CodingKey Implementations","kind":"article","type":"topic","url":"\/documentation\/marvelservice\/components\/schemas\/storysummary\/codingkeys\/codingkey-implementations","role":"collectionGroup","abstract":[]},"doc://MarvelService/SQ":{"type":"unresolvable","identifier":"doc:\/\/MarvelService\/SQ","title":"Swift.Equatable"},"doc://MarvelService/s16SendableMetatypeP":{"type":"unresolvable","identifier":"doc:\/\/MarvelService\/s16SendableMetatypeP","title":"Swift.SendableMetatype"},"doc://MarvelService/documentation/MarvelService/Components/Schemas/StorySummary/CodingKeys/resourceURI":{"identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Components\/Schemas\/StorySummary\/CodingKeys\/resourceURI","title":"Components.Schemas.StorySummary.CodingKeys.resourceURI","fragments":[{"text":"case","kind":"keyword"},{"text":" ","kind":"text"},{"text":"resourceURI","kind":"identifier"}],"kind":"symbol","type":"topic","url":"\/documentation\/marvelservice\/components\/schemas\/storysummary\/codingkeys\/resourceuri","role":"symbol","abstract":[]},"doc://MarvelService/s8SendableP":{"type":"unresolvable","identifier":"doc:\/\/MarvelService\/s8SendableP","title":"Swift.Sendable"},"doc://MarvelService/documentation/MarvelService/Components/Schemas/StorySummary/CodingKeys":{"title":"Components.Schemas.StorySummary.CodingKeys","abstract":[],"url":"\/documentation\/marvelservice\/components\/schemas\/storysummary\/codingkeys","navigatorTitle":[{"text":"CodingKeys","kind":"identifier"}],"kind":"symbol","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Components\/Schemas\/StorySummary\/CodingKeys","type":"topic","role":"symbol","fragments":[{"text":"enum","kind":"keyword"},{"text":" ","kind":"text"},{"text":"CodingKeys","kind":"identifier"}]},"doc://MarvelService/documentation/MarvelService/Components/Schemas/StorySummary/CodingKeys/Equatable-Implementations":{"identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Components\/Schemas\/StorySummary\/CodingKeys\/Equatable-Implementations","title":"Equatable Implementations","kind":"article","type":"topic","url":"\/documentation\/marvelservice\/components\/schemas\/storysummary\/codingkeys\/equatable-implementations","role":"collectionGroup","abstract":[]},"doc://MarvelService/documentation/MarvelService/Components/Schemas/StorySummary/CodingKeys/RawRepresentable-Implementations":{"identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Components\/Schemas\/StorySummary\/CodingKeys\/RawRepresentable-Implementations","title":"RawRepresentable Implementations","kind":"article","type":"topic","url":"\/documentation\/marvelservice\/components\/schemas\/storysummary\/codingkeys\/rawrepresentable-implementations","role":"collectionGroup","abstract":[]},"doc://MarvelService/s9CodingKeyP":{"type":"unresolvable","identifier":"doc:\/\/MarvelService\/s9CodingKeyP","title":"Swift.CodingKey"}}} |