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

{"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"}],"sections":[],"variants":[{"paths":["\/documentation\/marvelservice\/components\/schemas\/creatordatacontainer"],"traits":[{"interfaceLanguage":"swift"}]}],"primaryContentSections":[{"declarations":[{"platforms":["macOS"],"languages":["swift"],"tokens":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"CreatorDataContainer","kind":"identifier"}]}],"kind":"declarations"},{"content":[{"type":"heading","level":2,"text":"Overview","anchor":"overview"},{"type":"aside","style":"note","content":[{"inlineContent":[{"type":"text","text":"Generated from "},{"type":"codeVoice","code":"#\/components\/schemas\/CreatorDataContainer"},{"type":"text","text":"."}],"type":"paragraph"}],"name":"Remark"}],"kind":"content"}],"schemaVersion":{"major":0,"minor":3,"patch":0},"abstract":[{"type":"text","text":"A container type for lists of creators."}],"hierarchy":{"paths":[["doc:\/\/MarvelService\/documentation\/MarvelService","doc:\/\/MarvelService\/documentation\/MarvelService\/Components","doc:\/\/MarvelService\/documentation\/MarvelService\/Components\/Schemas"]]},"topicSections":[{"anchor":"Initializers","title":"Initializers","identifiers":["doc:\/\/MarvelService\/documentation\/MarvelService\/Components\/Schemas\/CreatorDataContainer\/init(from:)","doc:\/\/MarvelService\/documentation\/MarvelService\/Components\/Schemas\/CreatorDataContainer\/init(offset:limit:total:count:results:)"],"generated":true},{"anchor":"Instance-Properties","title":"Instance Properties","identifiers":["doc:\/\/MarvelService\/documentation\/MarvelService\/Components\/Schemas\/CreatorDataContainer\/count","doc:\/\/MarvelService\/documentation\/MarvelService\/Components\/Schemas\/CreatorDataContainer\/limit","doc:\/\/MarvelService\/documentation\/MarvelService\/Components\/Schemas\/CreatorDataContainer\/offset","doc:\/\/MarvelService\/documentation\/MarvelService\/Components\/Schemas\/CreatorDataContainer\/results","doc:\/\/MarvelService\/documentation\/MarvelService\/Components\/Schemas\/CreatorDataContainer\/total"],"generated":true},{"anchor":"Enumerations","title":"Enumerations","identifiers":["doc:\/\/MarvelService\/documentation\/MarvelService\/Components\/Schemas\/CreatorDataContainer\/CodingKeys"],"generated":true},{"anchor":"Default-Implementations","title":"Default Implementations","identifiers":["doc:\/\/MarvelService\/documentation\/MarvelService\/Components\/Schemas\/CreatorDataContainer\/Equatable-Implementations"],"generated":true}],"seeAlsoSections":[{"anchor":"Core-Entity-Containers","title":"Core Entity Containers","identifiers":["doc:\/\/MarvelService\/documentation\/MarvelService\/Components\/Schemas\/CharacterDataContainer","doc:\/\/MarvelService\/documentation\/MarvelService\/Components\/Schemas\/ComicDataContainer","doc:\/\/MarvelService\/documentation\/MarvelService\/Components\/Schemas\/EventDataContainer","doc:\/\/MarvelService\/documentation\/MarvelService\/Components\/Schemas\/SeriesDataContainer","doc:\/\/MarvelService\/documentation\/MarvelService\/Components\/Schemas\/StoryDataContainer"],"generated":true}],"identifier":{"url":"doc:\/\/MarvelService\/documentation\/MarvelService\/Components\/Schemas\/CreatorDataContainer","interfaceLanguage":"swift"},"kind":"symbol","metadata":{"title":"Components.Schemas.CreatorDataContainer","externalID":"s:13MarvelService10ComponentsO7SchemasO20CreatorDataContainerV","navigatorTitle":[{"text":"CreatorDataContainer","kind":"identifier"}],"role":"symbol","roleHeading":"Structure","modules":[{"name":"MarvelService"}],"symbolKind":"struct","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"CreatorDataContainer","kind":"identifier"}]},"references":{"doc://MarvelService/documentation/MarvelService/Components/Schemas/CreatorDataContainer/init(from:)":{"identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Components\/Schemas\/CreatorDataContainer\/init(from:)","title":"init(from:)","fragments":[{"text":"init","kind":"identifier"},{"text":"(","kind":"text"},{"text":"from","kind":"externalParam"},{"text":": any ","kind":"text"},{"preciseIdentifier":"s:s7DecoderP","text":"Decoder","kind":"typeIdentifier"},{"text":") ","kind":"text"},{"text":"throws","kind":"keyword"}],"kind":"symbol","type":"topic","url":"\/documentation\/marvelservice\/components\/schemas\/creatordatacontainer\/init(from:)","role":"symbol","abstract":[]},"doc://MarvelService/documentation/MarvelService/Components/Schemas/EventDataContainer":{"identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Components\/Schemas\/EventDataContainer","title":"Components.Schemas.EventDataContainer","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"EventDataContainer","kind":"identifier"}],"kind":"symbol","type":"topic","url":"\/documentation\/marvelservice\/components\/schemas\/eventdatacontainer","role":"symbol","navigatorTitle":[{"text":"EventDataContainer","kind":"identifier"}],"abstract":[{"text":"The container for the event data.","type":"text"}]},"doc://MarvelService/documentation/MarvelService/Components/Schemas/CreatorDataContainer/init(offset:limit:total:count:results:)":{"abstract":[{"type":"text","text":"Creates a new "},{"type":"codeVoice","code":"CreatorDataContainer"},{"type":"text","text":"."}],"role":"symbol","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Components\/Schemas\/CreatorDataContainer\/init(offset:limit:total:count:results:)","title":"init(offset:limit:total:count:results:)","fragments":[{"text":"init","kind":"identifier"},{"text":"(","kind":"text"},{"text":"offset","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"Int","preciseIdentifier":"s:Si","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"limit","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"Int","preciseIdentifier":"s:Si","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"total","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"Int","preciseIdentifier":"s:Si","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"count","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"Int","preciseIdentifier":"s:Si","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"results","kind":"externalParam"},{"text":": [","kind":"text"},{"text":"Components","preciseIdentifier":"s:13MarvelService10ComponentsO","kind":"typeIdentifier"},{"text":".","kind":"text"},{"text":"Schemas","preciseIdentifier":"s:13MarvelService10ComponentsO7SchemasO","kind":"typeIdentifier"},{"text":".","kind":"text"},{"text":"Creator","preciseIdentifier":"s:13MarvelService10ComponentsO7SchemasO7CreatorV","kind":"typeIdentifier"},{"text":"])","kind":"text"}],"kind":"symbol","url":"\/documentation\/marvelservice\/components\/schemas\/creatordatacontainer\/init(offset:limit:total:count:results:)","type":"topic"},"doc://MarvelService/documentation/MarvelService/Components/Schemas/CreatorDataContainer":{"url":"\/documentation\/marvelservice\/components\/schemas\/creatordatacontainer","title":"Components.Schemas.CreatorDataContainer","navigatorTitle":[{"text":"CreatorDataContainer","kind":"identifier"}],"type":"topic","abstract":[{"text":"A container type for lists of creators.","type":"text"}],"role":"symbol","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Components\/Schemas\/CreatorDataContainer","kind":"symbol","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"CreatorDataContainer","kind":"identifier"}]},"doc://MarvelService/documentation/MarvelService/Components/Schemas/StoryDataContainer":{"url":"\/documentation\/marvelservice\/components\/schemas\/storydatacontainer","title":"Components.Schemas.StoryDataContainer","navigatorTitle":[{"kind":"identifier","text":"StoryDataContainer"}],"type":"topic","abstract":[{"text":"The container for the story data.","type":"text"}],"role":"symbol","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Components\/Schemas\/StoryDataContainer","kind":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"StoryDataContainer"}]},"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":{"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/CreatorDataContainer/offset":{"title":"offset","abstract":[{"text":"The requested offset (number of skipped results) of the call.","type":"text"}],"url":"\/documentation\/marvelservice\/components\/schemas\/creatordatacontainer\/offset","kind":"symbol","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Components\/Schemas\/CreatorDataContainer\/offset","type":"topic","role":"symbol","fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"offset","kind":"identifier"},{"text":": ","kind":"text"},{"text":"Int","kind":"typeIdentifier","preciseIdentifier":"s:Si"}]},"doc://MarvelService/documentation/MarvelService/Components/Schemas/ComicDataContainer":{"url":"\/documentation\/marvelservice\/components\/schemas\/comicdatacontainer","title":"Components.Schemas.ComicDataContainer","navigatorTitle":[{"text":"ComicDataContainer","kind":"identifier"}],"type":"topic","abstract":[{"type":"text","text":"The container for the comic data."}],"role":"symbol","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Components\/Schemas\/ComicDataContainer","kind":"symbol","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"ComicDataContainer","kind":"identifier"}]},"doc://MarvelService/SE":{"type":"unresolvable","title":"Swift.Encodable","identifier":"doc:\/\/MarvelService\/SE"},"doc://MarvelService/documentation/MarvelService/Components/Schemas/CreatorDataContainer/CodingKeys":{"url":"\/documentation\/marvelservice\/components\/schemas\/creatordatacontainer\/codingkeys","title":"Components.Schemas.CreatorDataContainer.CodingKeys","navigatorTitle":[{"text":"CodingKeys","kind":"identifier"}],"type":"topic","abstract":[],"role":"symbol","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Components\/Schemas\/CreatorDataContainer\/CodingKeys","kind":"symbol","fragments":[{"text":"enum","kind":"keyword"},{"text":" ","kind":"text"},{"text":"CodingKeys","kind":"identifier"}]},"doc://MarvelService/documentation/MarvelService/Components/Schemas/CreatorDataContainer/results":{"url":"\/documentation\/marvelservice\/components\/schemas\/creatordatacontainer\/results","title":"results","type":"topic","abstract":[{"type":"text","text":"The list of creators returned by the call."}],"role":"symbol","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Components\/Schemas\/CreatorDataContainer\/results","kind":"symbol","fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"results","kind":"identifier"},{"text":": [","kind":"text"},{"text":"Components","preciseIdentifier":"s:13MarvelService10ComponentsO","kind":"typeIdentifier"},{"text":".","kind":"text"},{"text":"Schemas","preciseIdentifier":"s:13MarvelService10ComponentsO7SchemasO","kind":"typeIdentifier"},{"text":".","kind":"text"},{"text":"Creator","preciseIdentifier":"s:13MarvelService10ComponentsO7SchemasO7CreatorV","kind":"typeIdentifier"},{"text":"]","kind":"text"}]},"doc://MarvelService/documentation/MarvelService/Components/Schemas/CharacterDataContainer":{"abstract":[{"text":"The container for the character data.","type":"text"}],"role":"symbol","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Components\/Schemas\/CharacterDataContainer","navigatorTitle":[{"kind":"identifier","text":"CharacterDataContainer"}],"title":"Components.Schemas.CharacterDataContainer","fragments":[{"kind":"keyword","text":"struct"},{"text":" ","kind":"text"},{"text":"CharacterDataContainer","kind":"identifier"}],"kind":"symbol","type":"topic","url":"\/documentation\/marvelservice\/components\/schemas\/characterdatacontainer"},"doc://MarvelService/SH":{"type":"unresolvable","title":"Swift.Hashable","identifier":"doc:\/\/MarvelService\/SH"},"doc://MarvelService/Se":{"type":"unresolvable","title":"Swift.Decodable","identifier":"doc:\/\/MarvelService\/Se"},"doc://MarvelService/documentation/MarvelService/Components/Schemas/CreatorDataContainer/total":{"abstract":[{"text":"The total number of resources available given the current filter set.","type":"text"}],"role":"symbol","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Components\/Schemas\/CreatorDataContainer\/total","title":"total","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"total"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:Si","text":"Int"}],"kind":"symbol","type":"topic","url":"\/documentation\/marvelservice\/components\/schemas\/creatordatacontainer\/total"},"doc://MarvelService/documentation/MarvelService/Components/Schemas/CreatorDataContainer/count":{"identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Components\/Schemas\/CreatorDataContainer\/count","title":"count","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"count"},{"kind":"text","text":": "},{"preciseIdentifier":"s:Si","kind":"typeIdentifier","text":"Int"}],"kind":"symbol","type":"topic","url":"\/documentation\/marvelservice\/components\/schemas\/creatordatacontainer\/count","role":"symbol","abstract":[{"type":"text","text":"The total number of results returned by this call."}]},"doc://MarvelService/s16SendableMetatypeP":{"type":"unresolvable","title":"Swift.SendableMetatype","identifier":"doc:\/\/MarvelService\/s16SendableMetatypeP"},"doc://MarvelService/documentation/MarvelService/Components/Schemas/CreatorDataContainer/limit":{"identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Components\/Schemas\/CreatorDataContainer\/limit","title":"limit","fragments":[{"kind":"keyword","text":"var"},{"text":" ","kind":"text"},{"kind":"identifier","text":"limit"},{"kind":"text","text":": "},{"preciseIdentifier":"s:Si","kind":"typeIdentifier","text":"Int"}],"kind":"symbol","type":"topic","url":"\/documentation\/marvelservice\/components\/schemas\/creatordatacontainer\/limit","role":"symbol","abstract":[{"type":"text","text":"The requested result limit."}]},"doc://MarvelService/s8SendableP":{"type":"unresolvable","title":"Swift.Sendable","identifier":"doc:\/\/MarvelService\/s8SendableP"},"doc://MarvelService/documentation/MarvelService/Components/Schemas/CreatorDataContainer/Equatable-Implementations":{"url":"\/documentation\/marvelservice\/components\/schemas\/creatordatacontainer\/equatable-implementations","title":"Equatable Implementations","type":"topic","abstract":[],"role":"collectionGroup","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Components\/Schemas\/CreatorDataContainer\/Equatable-Implementations","kind":"article"},"doc://MarvelService/SQ":{"type":"unresolvable","title":"Swift.Equatable","identifier":"doc:\/\/MarvelService\/SQ"},"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/SeriesDataContainer":{"url":"\/documentation\/marvelservice\/components\/schemas\/seriesdatacontainer","title":"Components.Schemas.SeriesDataContainer","navigatorTitle":[{"kind":"identifier","text":"SeriesDataContainer"}],"type":"topic","abstract":[{"text":"The container for the series data.","type":"text"}],"role":"symbol","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Components\/Schemas\/SeriesDataContainer","kind":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"SeriesDataContainer"}]}}}