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

{"sections":[],"relationshipsSections":[{"title":"Conforms To","type":"conformsTo","kind":"relationships","identifiers":["doc:\/\/MarvelService\/Se","doc:\/\/MarvelService\/SE","doc:\/\/MarvelService\/SQ","doc:\/\/MarvelService\/SH","doc:\/\/MarvelService\/s8SendableP","doc:\/\/MarvelService\/s16SendableMetatypeP"]}],"abstract":[{"type":"text","text":"The wrapper for the story data."}],"seeAlsoSections":[{"title":"Core Entity Wrappers","generated":true,"anchor":"Core-Entity-Wrappers","identifiers":["doc:\/\/MarvelService\/documentation\/MarvelService\/Components\/Schemas\/CharacterDataWrapper","doc:\/\/MarvelService\/documentation\/MarvelService\/Components\/Schemas\/ComicDataWrapper","doc:\/\/MarvelService\/documentation\/MarvelService\/Components\/Schemas\/CreatorDataWrapper","doc:\/\/MarvelService\/documentation\/MarvelService\/Components\/Schemas\/EventDataWrapper","doc:\/\/MarvelService\/documentation\/MarvelService\/Components\/Schemas\/SeriesDataWrapper"]}],"identifier":{"url":"doc:\/\/MarvelService\/documentation\/MarvelService\/Components\/Schemas\/StoryDataWrapper","interfaceLanguage":"swift"},"primaryContentSections":[{"declarations":[{"tokens":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"StoryDataWrapper","kind":"identifier"}],"platforms":["macOS"],"languages":["swift"]}],"kind":"declarations"},{"content":[{"type":"heading","anchor":"overview","text":"Overview","level":2},{"type":"aside","name":"Remark","content":[{"type":"paragraph","inlineContent":[{"text":"Generated from ","type":"text"},{"type":"codeVoice","code":"#\/components\/schemas\/StoryDataWrapper"},{"text":".","type":"text"}]}],"style":"note"}],"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\/StoryDataWrapper\/init(code:status:copyright:attributionText:attributionHTML:data:etag:)","doc:\/\/MarvelService\/documentation\/MarvelService\/Components\/Schemas\/StoryDataWrapper\/init(from:)"]},{"title":"Instance Properties","generated":true,"anchor":"Instance-Properties","identifiers":["doc:\/\/MarvelService\/documentation\/MarvelService\/Components\/Schemas\/StoryDataWrapper\/attributionHTML","doc:\/\/MarvelService\/documentation\/MarvelService\/Components\/Schemas\/StoryDataWrapper\/attributionText","doc:\/\/MarvelService\/documentation\/MarvelService\/Components\/Schemas\/StoryDataWrapper\/code","doc:\/\/MarvelService\/documentation\/MarvelService\/Components\/Schemas\/StoryDataWrapper\/copyright","doc:\/\/MarvelService\/documentation\/MarvelService\/Components\/Schemas\/StoryDataWrapper\/data","doc:\/\/MarvelService\/documentation\/MarvelService\/Components\/Schemas\/StoryDataWrapper\/etag","doc:\/\/MarvelService\/documentation\/MarvelService\/Components\/Schemas\/StoryDataWrapper\/status"]},{"title":"Enumerations","generated":true,"anchor":"Enumerations","identifiers":["doc:\/\/MarvelService\/documentation\/MarvelService\/Components\/Schemas\/StoryDataWrapper\/CodingKeys"]},{"title":"Default Implementations","generated":true,"anchor":"Default-Implementations","identifiers":["doc:\/\/MarvelService\/documentation\/MarvelService\/Components\/Schemas\/StoryDataWrapper\/Equatable-Implementations"]}],"metadata":{"symbolKind":"struct","role":"symbol","navigatorTitle":[{"kind":"identifier","text":"StoryDataWrapper"}],"externalID":"s:13MarvelService10ComponentsO7SchemasO16StoryDataWrapperV","roleHeading":"Structure","title":"Components.Schemas.StoryDataWrapper","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"StoryDataWrapper","kind":"identifier"}],"modules":[{"name":"MarvelService"}]},"schemaVersion":{"minor":3,"major":0,"patch":0},"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/marvelservice\/components\/schemas\/storydatawrapper"]}],"references":{"doc://MarvelService/documentation/MarvelService/Components/Schemas/StoryDataWrapper/Equatable-Implementations":{"abstract":[],"role":"collectionGroup","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Components\/Schemas\/StoryDataWrapper\/Equatable-Implementations","title":"Equatable Implementations","kind":"article","type":"topic","url":"\/documentation\/marvelservice\/components\/schemas\/storydatawrapper\/equatable-implementations"},"doc://MarvelService/documentation/MarvelService/Components/Schemas/StoryDataWrapper/attributionHTML":{"url":"\/documentation\/marvelservice\/components\/schemas\/storydatawrapper\/attributionhtml","title":"attributionHTML","type":"topic","abstract":[{"text":"An HTML representation of the attribution notice for this result. Please display either this notice or the contents of the attributionText field on all screens which contain data from the Marvel Comics API.","type":"text"}],"role":"symbol","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Components\/Schemas\/StoryDataWrapper\/attributionHTML","kind":"symbol","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"attributionHTML"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"}]},"doc://MarvelService/documentation/MarvelService/Components/Schemas/StoryDataWrapper/code":{"url":"\/documentation\/marvelservice\/components\/schemas\/storydatawrapper\/code","title":"code","type":"topic","abstract":[{"type":"text","text":"The HTTP status code of the returned result."}],"role":"symbol","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Components\/Schemas\/StoryDataWrapper\/code","kind":"symbol","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"code"},{"kind":"text","text":": "},{"preciseIdentifier":"s:Si","kind":"typeIdentifier","text":"Int"}]},"doc://MarvelService/documentation/MarvelService/Components/Schemas/StoryDataWrapper/data":{"abstract":[],"role":"symbol","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Components\/Schemas\/StoryDataWrapper\/data","title":"data","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"data"},{"kind":"text","text":": "},{"preciseIdentifier":"s:13MarvelService10ComponentsO","kind":"typeIdentifier","text":"Components"},{"kind":"text","text":"."},{"preciseIdentifier":"s:13MarvelService10ComponentsO7SchemasO","kind":"typeIdentifier","text":"Schemas"},{"kind":"text","text":"."},{"preciseIdentifier":"s:13MarvelService10ComponentsO7SchemasO18StoryDataContainerV","kind":"typeIdentifier","text":"StoryDataContainer"}],"kind":"symbol","type":"topic","url":"\/documentation\/marvelservice\/components\/schemas\/storydatawrapper\/data"},"doc://MarvelService/SH":{"type":"unresolvable","identifier":"doc:\/\/MarvelService\/SH","title":"Swift.Hashable"},"doc://MarvelService/documentation/MarvelService/Components/Schemas/EventDataWrapper":{"url":"\/documentation\/marvelservice\/components\/schemas\/eventdatawrapper","title":"Components.Schemas.EventDataWrapper","navigatorTitle":[{"kind":"identifier","text":"EventDataWrapper"}],"type":"topic","abstract":[{"text":"The wrapper for the event data.","type":"text"}],"role":"symbol","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Components\/Schemas\/EventDataWrapper","kind":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"text":" ","kind":"text"},{"text":"EventDataWrapper","kind":"identifier"}]},"doc://MarvelService/documentation/MarvelService/Components/Schemas/CharacterDataWrapper":{"title":"Components.Schemas.CharacterDataWrapper","abstract":[{"type":"text","text":"The wrapper for the character data."}],"url":"\/documentation\/marvelservice\/components\/schemas\/characterdatawrapper","navigatorTitle":[{"kind":"identifier","text":"CharacterDataWrapper"}],"kind":"symbol","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Components\/Schemas\/CharacterDataWrapper","type":"topic","role":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"CharacterDataWrapper"}]},"doc://MarvelService/documentation/MarvelService/Components/Schemas/StoryDataWrapper/etag":{"identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Components\/Schemas\/StoryDataWrapper\/etag","title":"etag","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"etag"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"}],"kind":"symbol","type":"topic","url":"\/documentation\/marvelservice\/components\/schemas\/storydatawrapper\/etag","role":"symbol","abstract":[{"text":"A digest value of the content returned by the call.","type":"text"}]},"doc://MarvelService/Se":{"type":"unresolvable","identifier":"doc:\/\/MarvelService\/Se","title":"Swift.Decodable"},"doc://MarvelService/SE":{"type":"unresolvable","identifier":"doc:\/\/MarvelService\/SE","title":"Swift.Encodable"},"doc://MarvelService/documentation/MarvelService/Components/Schemas/CreatorDataWrapper":{"abstract":[{"text":"The wrapper for the creator data.","type":"text"}],"role":"symbol","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Components\/Schemas\/CreatorDataWrapper","navigatorTitle":[{"kind":"identifier","text":"CreatorDataWrapper"}],"title":"Components.Schemas.CreatorDataWrapper","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"CreatorDataWrapper"}],"kind":"symbol","type":"topic","url":"\/documentation\/marvelservice\/components\/schemas\/creatordatawrapper"},"doc://MarvelService/s8SendableP":{"type":"unresolvable","identifier":"doc:\/\/MarvelService\/s8SendableP","title":"Swift.Sendable"},"doc://MarvelService/documentation/MarvelService/Components/Schemas/ComicDataWrapper":{"abstract":[{"type":"text","text":"The wrapper for the comic data."}],"role":"symbol","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Components\/Schemas\/ComicDataWrapper","navigatorTitle":[{"text":"ComicDataWrapper","kind":"identifier"}],"title":"Components.Schemas.ComicDataWrapper","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"ComicDataWrapper","kind":"identifier"}],"kind":"symbol","type":"topic","url":"\/documentation\/marvelservice\/components\/schemas\/comicdatawrapper"},"doc://MarvelService/documentation/MarvelService/Components/Schemas/SeriesDataWrapper":{"title":"Components.Schemas.SeriesDataWrapper","abstract":[{"type":"text","text":"The wrapper for the series data."}],"url":"\/documentation\/marvelservice\/components\/schemas\/seriesdatawrapper","navigatorTitle":[{"text":"SeriesDataWrapper","kind":"identifier"}],"kind":"symbol","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Components\/Schemas\/SeriesDataWrapper","type":"topic","role":"symbol","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"SeriesDataWrapper","kind":"identifier"}]},"doc://MarvelService/documentation/MarvelService/Components/Schemas/StoryDataWrapper/init(from:)":{"abstract":[],"role":"symbol","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Components\/Schemas\/StoryDataWrapper\/init(from:)","title":"init(from:)","fragments":[{"kind":"identifier","text":"init"},{"kind":"text","text":"("},{"kind":"externalParam","text":"from"},{"kind":"text","text":": any "},{"preciseIdentifier":"s:s7DecoderP","kind":"typeIdentifier","text":"Decoder"},{"kind":"text","text":") "},{"kind":"keyword","text":"throws"}],"kind":"symbol","type":"topic","url":"\/documentation\/marvelservice\/components\/schemas\/storydatawrapper\/init(from:)"},"doc://MarvelService/documentation/MarvelService/Components/Schemas/StoryDataWrapper":{"abstract":[{"type":"text","text":"The wrapper for the story data."}],"role":"symbol","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Components\/Schemas\/StoryDataWrapper","navigatorTitle":[{"text":"StoryDataWrapper","kind":"identifier"}],"title":"Components.Schemas.StoryDataWrapper","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"StoryDataWrapper","kind":"identifier"}],"kind":"symbol","url":"\/documentation\/marvelservice\/components\/schemas\/storydatawrapper","type":"topic"},"doc://MarvelService/documentation/MarvelService/Components/Schemas/StoryDataWrapper/CodingKeys":{"title":"Components.Schemas.StoryDataWrapper.CodingKeys","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Components\/Schemas\/StoryDataWrapper\/CodingKeys","fragments":[{"kind":"keyword","text":"enum"},{"kind":"text","text":" "},{"kind":"identifier","text":"CodingKeys"}],"kind":"symbol","type":"topic","url":"\/documentation\/marvelservice\/components\/schemas\/storydatawrapper\/codingkeys","role":"symbol","navigatorTitle":[{"kind":"identifier","text":"CodingKeys"}],"abstract":[]},"doc://MarvelService/documentation/MarvelService/Components/Schemas/StoryDataWrapper/copyright":{"abstract":[{"text":"The copyright notice for the returned result.","type":"text"}],"role":"symbol","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Components\/Schemas\/StoryDataWrapper\/copyright","title":"copyright","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"copyright"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"}],"kind":"symbol","type":"topic","url":"\/documentation\/marvelservice\/components\/schemas\/storydatawrapper\/copyright"},"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":{"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/StoryDataWrapper/init(code:status:copyright:attributionText:attributionHTML:data:etag:)":{"abstract":[{"text":"Creates a new ","type":"text"},{"code":"StoryDataWrapper","type":"codeVoice"},{"text":".","type":"text"}],"role":"symbol","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Components\/Schemas\/StoryDataWrapper\/init(code:status:copyright:attributionText:attributionHTML:data:etag:)","title":"init(code:status:copyright:attributionText:attributionHTML:data:etag:)","fragments":[{"kind":"identifier","text":"init"},{"kind":"text","text":"("},{"kind":"externalParam","text":"code"},{"kind":"text","text":": "},{"preciseIdentifier":"s:Si","kind":"typeIdentifier","text":"Int"},{"kind":"text","text":", "},{"kind":"externalParam","text":"status"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":", "},{"kind":"externalParam","text":"copyright"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":", "},{"kind":"externalParam","text":"attributionText"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":", "},{"kind":"externalParam","text":"attributionHTML"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":", "},{"kind":"externalParam","text":"data"},{"kind":"text","text":": "},{"preciseIdentifier":"s:13MarvelService10ComponentsO","kind":"typeIdentifier","text":"Components"},{"kind":"text","text":"."},{"preciseIdentifier":"s:13MarvelService10ComponentsO7SchemasO","kind":"typeIdentifier","text":"Schemas"},{"kind":"text","text":"."},{"preciseIdentifier":"s:13MarvelService10ComponentsO7SchemasO18StoryDataContainerV","kind":"typeIdentifier","text":"StoryDataContainer"},{"kind":"text","text":", "},{"kind":"externalParam","text":"etag"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":")"}],"kind":"symbol","type":"topic","url":"\/documentation\/marvelservice\/components\/schemas\/storydatawrapper\/init(code:status:copyright:attributiontext:attributionhtml:data:etag:)"},"doc://MarvelService/documentation/MarvelService/Components/Schemas/StoryDataWrapper/status":{"url":"\/documentation\/marvelservice\/components\/schemas\/storydatawrapper\/status","title":"status","type":"topic","abstract":[{"text":"A string description of the call status.","type":"text"}],"role":"symbol","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Components\/Schemas\/StoryDataWrapper\/status","kind":"symbol","fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"status","kind":"identifier"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"}]},"doc://MarvelService/SQ":{"type":"unresolvable","identifier":"doc:\/\/MarvelService\/SQ","title":"Swift.Equatable"},"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/StoryDataWrapper/attributionText":{"abstract":[{"type":"text","text":"The attribution notice for this result. Please display either this notice or the contents of the attributionHTML field on all screens which contain data from the Marvel Comics API."}],"role":"symbol","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Components\/Schemas\/StoryDataWrapper\/attributionText","title":"attributionText","fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"attributionText","kind":"identifier"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"}],"kind":"symbol","url":"\/documentation\/marvelservice\/components\/schemas\/storydatawrapper\/attributiontext","type":"topic"}}}