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