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