Files
marvel-service/docs/data/documentation/marvelservice/components/schemas/charactersummary.json
T
javier d5bd9feb0a First version of the library documentation (#7)
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>
2025-10-05 18:41:22 +00:00

1 line
14 KiB
JSON

{"sections":[],"relationshipsSections":[{"title":"Conforms To","identifiers":["doc:\/\/MarvelService\/Se","doc:\/\/MarvelService\/SE","doc:\/\/MarvelService\/SQ","doc:\/\/MarvelService\/SH","doc:\/\/MarvelService\/s8SendableP","doc:\/\/MarvelService\/s16SendableMetatypeP"],"type":"conformsTo","kind":"relationships"}],"abstract":[{"text":"A type that represents a summary of a character resource.","type":"text"}],"seeAlsoSections":[{"generated":true,"anchor":"Core-Entity-Summaries","title":"Core Entity Summaries","identifiers":["doc:\/\/MarvelService\/documentation\/MarvelService\/Components\/Schemas\/ComicSummary","doc:\/\/MarvelService\/documentation\/MarvelService\/Components\/Schemas\/CreatorSummary","doc:\/\/MarvelService\/documentation\/MarvelService\/Components\/Schemas\/EventSummary","doc:\/\/MarvelService\/documentation\/MarvelService\/Components\/Schemas\/SeriesSummary","doc:\/\/MarvelService\/documentation\/MarvelService\/Components\/Schemas\/StorySummary"]}],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/MarvelService\/documentation\/MarvelService\/Components\/Schemas\/CharacterSummary"},"primaryContentSections":[{"kind":"declarations","declarations":[{"platforms":["macOS"],"languages":["swift"],"tokens":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"CharacterSummary","kind":"identifier"}]}]},{"content":[{"type":"heading","level":2,"anchor":"overview","text":"Overview"},{"type":"aside","name":"Remark","style":"note","content":[{"inlineContent":[{"text":"Generated from ","type":"text"},{"code":"#\/components\/schemas\/CharacterSummary","type":"codeVoice"},{"type":"text","text":"."}],"type":"paragraph"}]}],"kind":"content"}],"kind":"symbol","hierarchy":{"paths":[["doc:\/\/MarvelService\/documentation\/MarvelService","doc:\/\/MarvelService\/documentation\/MarvelService\/Components","doc:\/\/MarvelService\/documentation\/MarvelService\/Components\/Schemas"]]},"topicSections":[{"title":"Initializers","generated":true,"anchor":"Initializers","identifiers":["doc:\/\/MarvelService\/documentation\/MarvelService\/Components\/Schemas\/CharacterSummary\/init(from:)","doc:\/\/MarvelService\/documentation\/MarvelService\/Components\/Schemas\/CharacterSummary\/init(resourceURI:name:role:)"]},{"identifiers":["doc:\/\/MarvelService\/documentation\/MarvelService\/Components\/Schemas\/CharacterSummary\/name","doc:\/\/MarvelService\/documentation\/MarvelService\/Components\/Schemas\/CharacterSummary\/resourceURI","doc:\/\/MarvelService\/documentation\/MarvelService\/Components\/Schemas\/CharacterSummary\/role"],"title":"Instance Properties","anchor":"Instance-Properties","generated":true},{"title":"Enumerations","generated":true,"anchor":"Enumerations","identifiers":["doc:\/\/MarvelService\/documentation\/MarvelService\/Components\/Schemas\/CharacterSummary\/CodingKeys"]},{"title":"Default Implementations","generated":true,"anchor":"Default-Implementations","identifiers":["doc:\/\/MarvelService\/documentation\/MarvelService\/Components\/Schemas\/CharacterSummary\/Equatable-Implementations"]}],"metadata":{"fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"CharacterSummary","kind":"identifier"}],"navigatorTitle":[{"text":"CharacterSummary","kind":"identifier"}],"modules":[{"name":"MarvelService"}],"externalID":"s:13MarvelService10ComponentsO7SchemasO16CharacterSummaryV","roleHeading":"Structure","symbolKind":"struct","role":"symbol","title":"Components.Schemas.CharacterSummary"},"schemaVersion":{"minor":3,"patch":0,"major":0},"variants":[{"paths":["\/documentation\/marvelservice\/components\/schemas\/charactersummary"],"traits":[{"interfaceLanguage":"swift"}]}],"references":{"doc://MarvelService/documentation/MarvelService/Components/Schemas/CharacterSummary/Equatable-Implementations":{"url":"\/documentation\/marvelservice\/components\/schemas\/charactersummary\/equatable-implementations","title":"Equatable Implementations","type":"topic","abstract":[],"role":"collectionGroup","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Components\/Schemas\/CharacterSummary\/Equatable-Implementations","kind":"article"},"doc://MarvelService/documentation/MarvelService/Components/Schemas/CharacterSummary/resourceURI":{"url":"\/documentation\/marvelservice\/components\/schemas\/charactersummary\/resourceuri","title":"resourceURI","type":"topic","abstract":[{"type":"text","text":"The path to the individual character resource."}],"role":"symbol","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Components\/Schemas\/CharacterSummary\/resourceURI","kind":"symbol","fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"resourceURI","kind":"identifier"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"}]},"doc://MarvelService/documentation/MarvelService/Components/Schemas/CharacterSummary/name":{"abstract":[{"type":"text","text":"The full name of the character."}],"role":"symbol","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Components\/Schemas\/CharacterSummary\/name","title":"name","fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"name","kind":"identifier"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"}],"kind":"symbol","url":"\/documentation\/marvelservice\/components\/schemas\/charactersummary\/name","type":"topic"},"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/EventSummary":{"fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"EventSummary"}],"kind":"symbol","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Components\/Schemas\/EventSummary","navigatorTitle":[{"text":"EventSummary","kind":"identifier"}],"url":"\/documentation\/marvelservice\/components\/schemas\/eventsummary","title":"Components.Schemas.EventSummary","role":"symbol","abstract":[{"type":"text","text":"A type that represents a summary of an event resource."}],"type":"topic"},"doc://MarvelService/documentation/MarvelService/Components/Schemas/CharacterSummary/role":{"abstract":[{"type":"text","text":"The role of the creator in the parent entity."}],"role":"symbol","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Components\/Schemas\/CharacterSummary\/role","title":"role","fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"role","kind":"identifier"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"}],"kind":"symbol","url":"\/documentation\/marvelservice\/components\/schemas\/charactersummary\/role","type":"topic"},"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/documentation/MarvelService/Components/Schemas/CharacterSummary/init(resourceURI:name:role:)":{"title":"init(resourceURI:name:role:)","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Components\/Schemas\/CharacterSummary\/init(resourceURI:name:role:)","fragments":[{"kind":"identifier","text":"init"},{"kind":"text","text":"("},{"kind":"externalParam","text":"resourceURI"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":", "},{"kind":"externalParam","text":"name"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":", "},{"kind":"externalParam","text":"role"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":")"}],"kind":"symbol","type":"topic","url":"\/documentation\/marvelservice\/components\/schemas\/charactersummary\/init(resourceuri:name:role:)","role":"symbol","abstract":[{"type":"text","text":"Creates a new "},{"type":"codeVoice","code":"CharacterSummary"},{"type":"text","text":"."}]},"doc://MarvelService/SQ":{"type":"unresolvable","identifier":"doc:\/\/MarvelService\/SQ","title":"Swift.Equatable"},"doc://MarvelService/documentation/MarvelService/Components/Schemas/CreatorSummary":{"title":"Components.Schemas.CreatorSummary","abstract":[{"text":"A type that represents a summary of a creator resource.","type":"text"}],"url":"\/documentation\/marvelservice\/components\/schemas\/creatorsummary","navigatorTitle":[{"text":"CreatorSummary","kind":"identifier"}],"kind":"symbol","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Components\/Schemas\/CreatorSummary","type":"topic","role":"symbol","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"CreatorSummary","kind":"identifier"}]},"doc://MarvelService/documentation/MarvelService/Components/Schemas/CharacterSummary":{"abstract":[{"type":"text","text":"A type that represents a summary of a character resource."}],"role":"symbol","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Components\/Schemas\/CharacterSummary","navigatorTitle":[{"kind":"identifier","text":"CharacterSummary"}],"title":"Components.Schemas.CharacterSummary","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"CharacterSummary"}],"kind":"symbol","type":"topic","url":"\/documentation\/marvelservice\/components\/schemas\/charactersummary"},"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/CharacterSummary/init(from:)":{"url":"\/documentation\/marvelservice\/components\/schemas\/charactersummary\/init(from:)","title":"init(from:)","type":"topic","abstract":[],"role":"symbol","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Components\/Schemas\/CharacterSummary\/init(from:)","kind":"symbol","fragments":[{"kind":"identifier","text":"init"},{"kind":"text","text":"("},{"kind":"externalParam","text":"from"},{"kind":"text","text":": any "},{"kind":"typeIdentifier","preciseIdentifier":"s:s7DecoderP","text":"Decoder"},{"kind":"text","text":") "},{"kind":"keyword","text":"throws"}]},"doc://MarvelService/s8SendableP":{"type":"unresolvable","identifier":"doc:\/\/MarvelService\/s8SendableP","title":"Swift.Sendable"},"doc://MarvelService/documentation/MarvelService/Components/Schemas/ComicSummary":{"url":"\/documentation\/marvelservice\/components\/schemas\/comicsummary","title":"Components.Schemas.ComicSummary","navigatorTitle":[{"text":"ComicSummary","kind":"identifier"}],"type":"topic","abstract":[{"type":"text","text":"A type that represents a summary of a comic resource."}],"role":"symbol","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Components\/Schemas\/ComicSummary","kind":"symbol","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"ComicSummary","kind":"identifier"}]},"doc://MarvelService/documentation/MarvelService/Components/Schemas/CharacterSummary/CodingKeys":{"abstract":[],"role":"symbol","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Components\/Schemas\/CharacterSummary\/CodingKeys","navigatorTitle":[{"text":"CodingKeys","kind":"identifier"}],"title":"Components.Schemas.CharacterSummary.CodingKeys","fragments":[{"text":"enum","kind":"keyword"},{"text":" ","kind":"text"},{"text":"CodingKeys","kind":"identifier"}],"kind":"symbol","type":"topic","url":"\/documentation\/marvelservice\/components\/schemas\/charactersummary\/codingkeys"},"doc://MarvelService/SE":{"type":"unresolvable","identifier":"doc:\/\/MarvelService\/SE","title":"Swift.Encodable"},"doc://MarvelService/SH":{"type":"unresolvable","identifier":"doc:\/\/MarvelService\/SH","title":"Swift.Hashable"},"doc://MarvelService/Se":{"type":"unresolvable","identifier":"doc:\/\/MarvelService\/Se","title":"Swift.Decodable"},"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/s16SendableMetatypeP":{"type":"unresolvable","identifier":"doc:\/\/MarvelService\/s16SendableMetatypeP","title":"Swift.SendableMetatype"},"doc://MarvelService/documentation/MarvelService/Components/Schemas/SeriesSummary":{"url":"\/documentation\/marvelservice\/components\/schemas\/seriessummary","title":"Components.Schemas.SeriesSummary","navigatorTitle":[{"text":"SeriesSummary","kind":"identifier"}],"type":"topic","abstract":[{"type":"text","text":"A type that represents a summary of a series resource."}],"role":"symbol","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Components\/Schemas\/SeriesSummary","kind":"symbol","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"SeriesSummary","kind":"identifier"}]}}}