Files
marvel-service/docs/data/documentation/marvelservice/components/schemas/comicsummary.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
13 KiB
JSON

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