Files
marvel-service/docs/data/documentation/marvelservice/components/schemas/creatordatawrapper.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":[{"identifiers":["doc:\/\/MarvelService\/Se","doc:\/\/MarvelService\/SE","doc:\/\/MarvelService\/SQ","doc:\/\/MarvelService\/SH","doc:\/\/MarvelService\/s8SendableP","doc:\/\/MarvelService\/s16SendableMetatypeP"],"type":"conformsTo","title":"Conforms To","kind":"relationships"}],"abstract":[{"type":"text","text":"The wrapper for the creator data."}],"seeAlsoSections":[{"identifiers":["doc:\/\/MarvelService\/documentation\/MarvelService\/Components\/Schemas\/CharacterDataWrapper","doc:\/\/MarvelService\/documentation\/MarvelService\/Components\/Schemas\/ComicDataWrapper","doc:\/\/MarvelService\/documentation\/MarvelService\/Components\/Schemas\/EventDataWrapper","doc:\/\/MarvelService\/documentation\/MarvelService\/Components\/Schemas\/SeriesDataWrapper","doc:\/\/MarvelService\/documentation\/MarvelService\/Components\/Schemas\/StoryDataWrapper"],"anchor":"Core-Entity-Wrappers","title":"Core Entity Wrappers","generated":true}],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/MarvelService\/documentation\/MarvelService\/Components\/Schemas\/CreatorDataWrapper"},"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"CreatorDataWrapper"}],"languages":["swift"],"platforms":["macOS"]}]},{"content":[{"type":"heading","text":"Overview","anchor":"overview","level":2},{"name":"Remark","type":"aside","style":"note","content":[{"type":"paragraph","inlineContent":[{"text":"Generated from ","type":"text"},{"type":"codeVoice","code":"#\/components\/schemas\/CreatorDataWrapper"},{"type":"text","text":"."}]}]}],"kind":"content"}],"kind":"symbol","hierarchy":{"paths":[["doc:\/\/MarvelService\/documentation\/MarvelService","doc:\/\/MarvelService\/documentation\/MarvelService\/Components","doc:\/\/MarvelService\/documentation\/MarvelService\/Components\/Schemas"]]},"topicSections":[{"identifiers":["doc:\/\/MarvelService\/documentation\/MarvelService\/Components\/Schemas\/CreatorDataWrapper\/init(code:status:copyright:attributionText:attributionHTML:data:etag:)","doc:\/\/MarvelService\/documentation\/MarvelService\/Components\/Schemas\/CreatorDataWrapper\/init(from:)"],"generated":true,"anchor":"Initializers","title":"Initializers"},{"identifiers":["doc:\/\/MarvelService\/documentation\/MarvelService\/Components\/Schemas\/CreatorDataWrapper\/attributionHTML","doc:\/\/MarvelService\/documentation\/MarvelService\/Components\/Schemas\/CreatorDataWrapper\/attributionText","doc:\/\/MarvelService\/documentation\/MarvelService\/Components\/Schemas\/CreatorDataWrapper\/code","doc:\/\/MarvelService\/documentation\/MarvelService\/Components\/Schemas\/CreatorDataWrapper\/copyright","doc:\/\/MarvelService\/documentation\/MarvelService\/Components\/Schemas\/CreatorDataWrapper\/data","doc:\/\/MarvelService\/documentation\/MarvelService\/Components\/Schemas\/CreatorDataWrapper\/etag","doc:\/\/MarvelService\/documentation\/MarvelService\/Components\/Schemas\/CreatorDataWrapper\/status"],"generated":true,"anchor":"Instance-Properties","title":"Instance Properties"},{"identifiers":["doc:\/\/MarvelService\/documentation\/MarvelService\/Components\/Schemas\/CreatorDataWrapper\/CodingKeys"],"generated":true,"anchor":"Enumerations","title":"Enumerations"},{"identifiers":["doc:\/\/MarvelService\/documentation\/MarvelService\/Components\/Schemas\/CreatorDataWrapper\/Equatable-Implementations"],"anchor":"Default-Implementations","title":"Default Implementations","generated":true}],"metadata":{"title":"Components.Schemas.CreatorDataWrapper","fragments":[{"text":"struct","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"CreatorDataWrapper"}],"externalID":"s:13MarvelService10ComponentsO7SchemasO18CreatorDataWrapperV","roleHeading":"Structure","role":"symbol","symbolKind":"struct","modules":[{"name":"MarvelService"}],"navigatorTitle":[{"kind":"identifier","text":"CreatorDataWrapper"}]},"schemaVersion":{"major":0,"patch":0,"minor":3},"variants":[{"paths":["\/documentation\/marvelservice\/components\/schemas\/creatordatawrapper"],"traits":[{"interfaceLanguage":"swift"}]}],"references":{"doc://MarvelService/documentation/MarvelService/Components/Schemas/CreatorDataWrapper/code":{"abstract":[{"type":"text","text":"The HTTP status code of the returned result."}],"role":"symbol","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Components\/Schemas\/CreatorDataWrapper\/code","title":"code","fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"code","kind":"identifier"},{"text":": ","kind":"text"},{"text":"Int","kind":"typeIdentifier","preciseIdentifier":"s:Si"}],"kind":"symbol","type":"topic","url":"\/documentation\/marvelservice\/components\/schemas\/creatordatawrapper\/code"},"doc://MarvelService/documentation/MarvelService/Components/Schemas/CreatorDataWrapper/CodingKeys":{"title":"Components.Schemas.CreatorDataWrapper.CodingKeys","abstract":[],"url":"\/documentation\/marvelservice\/components\/schemas\/creatordatawrapper\/codingkeys","navigatorTitle":[{"kind":"identifier","text":"CodingKeys"}],"kind":"symbol","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Components\/Schemas\/CreatorDataWrapper\/CodingKeys","type":"topic","role":"symbol","fragments":[{"kind":"keyword","text":"enum"},{"kind":"text","text":" "},{"kind":"identifier","text":"CodingKeys"}]},"doc://MarvelService/SH":{"type":"unresolvable","title":"Swift.Hashable","identifier":"doc:\/\/MarvelService\/SH"},"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/Se":{"identifier":"doc:\/\/MarvelService\/Se","title":"Swift.Decodable","type":"unresolvable"},"doc://MarvelService/documentation/MarvelService/Components/Schemas/CreatorDataWrapper/status":{"identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Components\/Schemas\/CreatorDataWrapper\/status","title":"status","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"status"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"}],"kind":"symbol","type":"topic","url":"\/documentation\/marvelservice\/components\/schemas\/creatordatawrapper\/status","role":"symbol","abstract":[{"text":"A string description of the call status.","type":"text"}]},"doc://MarvelService/SE":{"identifier":"doc:\/\/MarvelService\/SE","title":"Swift.Encodable","type":"unresolvable"},"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/documentation/MarvelService/Components/Schemas/CreatorDataWrapper/copyright":{"url":"\/documentation\/marvelservice\/components\/schemas\/creatordatawrapper\/copyright","title":"copyright","type":"topic","abstract":[{"text":"The copyright notice for the returned result.","type":"text"}],"role":"symbol","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Components\/Schemas\/CreatorDataWrapper\/copyright","kind":"symbol","fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"copyright","kind":"identifier"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"}]},"doc://MarvelService/s8SendableP":{"identifier":"doc:\/\/MarvelService\/s8SendableP","title":"Swift.Sendable","type":"unresolvable"},"doc://MarvelService/documentation/MarvelService/Components/Schemas/CreatorDataWrapper/attributionText":{"url":"\/documentation\/marvelservice\/components\/schemas\/creatordatawrapper\/attributiontext","title":"attributionText","type":"topic","abstract":[{"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.","type":"text"}],"role":"symbol","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Components\/Schemas\/CreatorDataWrapper\/attributionText","kind":"symbol","fragments":[{"text":"var","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"attributionText"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"}]},"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/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/CreatorDataWrapper/init(code:status:copyright:attributionText:attributionHTML:data:etag:)":{"title":"init(code:status:copyright:attributionText:attributionHTML:data:etag:)","abstract":[{"text":"Creates a new ","type":"text"},{"code":"CreatorDataWrapper","type":"codeVoice"},{"text":".","type":"text"}],"url":"\/documentation\/marvelservice\/components\/schemas\/creatordatawrapper\/init(code:status:copyright:attributiontext:attributionhtml:data:etag:)","kind":"symbol","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Components\/Schemas\/CreatorDataWrapper\/init(code:status:copyright:attributionText:attributionHTML:data:etag:)","type":"topic","role":"symbol","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:13MarvelService10ComponentsO7SchemasO20CreatorDataContainerV","kind":"typeIdentifier","text":"CreatorDataContainer"},{"kind":"text","text":", "},{"kind":"externalParam","text":"etag"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":")"}]},"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/CreatorDataWrapper/attributionHTML":{"title":"attributionHTML","abstract":[{"type":"text","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."}],"url":"\/documentation\/marvelservice\/components\/schemas\/creatordatawrapper\/attributionhtml","kind":"symbol","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Components\/Schemas\/CreatorDataWrapper\/attributionHTML","type":"topic","role":"symbol","fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"attributionHTML","kind":"identifier"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"}]},"doc://MarvelService/documentation/MarvelService/Components/Schemas/CreatorDataWrapper/data":{"fragments":[{"text":"var","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"data"},{"kind":"text","text":": "},{"text":"Components","kind":"typeIdentifier","preciseIdentifier":"s:13MarvelService10ComponentsO"},{"kind":"text","text":"."},{"preciseIdentifier":"s:13MarvelService10ComponentsO7SchemasO","kind":"typeIdentifier","text":"Schemas"},{"text":".","kind":"text"},{"text":"CreatorDataContainer","kind":"typeIdentifier","preciseIdentifier":"s:13MarvelService10ComponentsO7SchemasO20CreatorDataContainerV"}],"kind":"symbol","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Components\/Schemas\/CreatorDataWrapper\/data","url":"\/documentation\/marvelservice\/components\/schemas\/creatordatawrapper\/data","title":"data","role":"symbol","abstract":[],"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/s16SendableMetatypeP":{"title":"Swift.SendableMetatype","type":"unresolvable","identifier":"doc:\/\/MarvelService\/s16SendableMetatypeP"},"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/CreatorDataWrapper/etag":{"url":"\/documentation\/marvelservice\/components\/schemas\/creatordatawrapper\/etag","title":"etag","type":"topic","abstract":[{"text":"A digest value of the content returned by the call.","type":"text"}],"role":"symbol","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Components\/Schemas\/CreatorDataWrapper\/etag","kind":"symbol","fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"etag","kind":"identifier"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"}]},"doc://MarvelService/documentation/MarvelService/Components/Schemas/CreatorDataWrapper/init(from:)":{"url":"\/documentation\/marvelservice\/components\/schemas\/creatordatawrapper\/init(from:)","title":"init(from:)","type":"topic","abstract":[],"role":"symbol","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Components\/Schemas\/CreatorDataWrapper\/init(from:)","kind":"symbol","fragments":[{"kind":"identifier","text":"init"},{"kind":"text","text":"("},{"kind":"externalParam","text":"from"},{"kind":"text","text":": any "},{"kind":"typeIdentifier","text":"Decoder","preciseIdentifier":"s:s7DecoderP"},{"kind":"text","text":") "},{"kind":"keyword","text":"throws"}]},"doc://MarvelService/SQ":{"identifier":"doc:\/\/MarvelService\/SQ","title":"Swift.Equatable","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/CreatorDataWrapper/Equatable-Implementations":{"url":"\/documentation\/marvelservice\/components\/schemas\/creatordatawrapper\/equatable-implementations","title":"Equatable Implementations","type":"topic","abstract":[],"role":"collectionGroup","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Components\/Schemas\/CreatorDataWrapper\/Equatable-Implementations","kind":"article"}}}