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
6.6 KiB
JSON
1 line
6.6 KiB
JSON
{"sections":[],"variants":[{"paths":["\/documentation\/marvelservice\/components\/schemas\/event\/characters"],"traits":[{"interfaceLanguage":"swift"}]}],"primaryContentSections":[{"declarations":[{"languages":["swift"],"tokens":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"characters","kind":"identifier"},{"text":": ","kind":"text"},{"text":"Components","preciseIdentifier":"s:13MarvelService10ComponentsO","kind":"typeIdentifier","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Components"},{"text":".","kind":"text"},{"text":"Schemas","preciseIdentifier":"s:13MarvelService10ComponentsO7SchemasO","kind":"typeIdentifier","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Components\/Schemas"},{"text":".","kind":"text"},{"text":"CharacterList","preciseIdentifier":"s:13MarvelService10ComponentsO7SchemasO13CharacterListV","kind":"typeIdentifier","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Components\/Schemas\/CharacterList"}],"platforms":["macOS"]}],"kind":"declarations"},{"content":[{"level":2,"type":"heading","anchor":"discussion","text":"Discussion"},{"name":"Remark","content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"Generated from "},{"code":"#\/components\/schemas\/Event\/characters","type":"codeVoice"},{"type":"text","text":"."}]}],"style":"note","type":"aside"}],"kind":"content"}],"schemaVersion":{"major":0,"minor":3,"patch":0},"abstract":[{"type":"text","text":"A resource list containing the characters which appear in this event."}],"hierarchy":{"paths":[["doc:\/\/MarvelService\/documentation\/MarvelService","doc:\/\/MarvelService\/documentation\/MarvelService\/Components","doc:\/\/MarvelService\/documentation\/MarvelService\/Components\/Schemas","doc:\/\/MarvelService\/documentation\/MarvelService\/Components\/Schemas\/Event"]]},"identifier":{"url":"doc:\/\/MarvelService\/documentation\/MarvelService\/Components\/Schemas\/Event\/characters","interfaceLanguage":"swift"},"kind":"symbol","metadata":{"title":"characters","externalID":"s:13MarvelService10ComponentsO7SchemasO5EventV10charactersAE13CharacterListVvp","role":"symbol","modules":[{"name":"MarvelService"}],"roleHeading":"Instance Property","symbolKind":"property","fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"characters","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":"CharacterList","preciseIdentifier":"s:13MarvelService10ComponentsO7SchemasO13CharacterListV","kind":"typeIdentifier"}]},"references":{"doc://MarvelService/documentation/MarvelService/Components/Schemas/Event":{"navigatorTitle":[{"text":"Event","kind":"identifier"}],"identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Components\/Schemas\/Event","url":"\/documentation\/marvelservice\/components\/schemas\/event","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Event","kind":"identifier"}],"role":"symbol","type":"topic","title":"Components.Schemas.Event","abstract":[{"text":"An event resource type that represents big, universe-altering storylines (e.g. Infinity). A comic’s appearance in an event is often independent of its membership in a series.","type":"text"}],"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/CharacterList":{"url":"\/documentation\/marvelservice\/components\/schemas\/characterlist","title":"Components.Schemas.CharacterList","navigatorTitle":[{"text":"CharacterList","kind":"identifier"}],"type":"topic","abstract":[{"type":"text","text":"A resource list containing characters which appear in this story."}],"role":"symbol","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Components\/Schemas\/CharacterList","kind":"symbol","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"CharacterList","kind":"identifier"}]},"doc://MarvelService/documentation/MarvelService/Components/Schemas/Event/characters":{"fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"characters","kind":"identifier"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:13MarvelService10ComponentsO","text":"Components","kind":"typeIdentifier"},{"text":".","kind":"text"},{"preciseIdentifier":"s:13MarvelService10ComponentsO7SchemasO","text":"Schemas","kind":"typeIdentifier"},{"text":".","kind":"text"},{"preciseIdentifier":"s:13MarvelService10ComponentsO7SchemasO13CharacterListV","text":"CharacterList","kind":"typeIdentifier"}],"identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Components\/Schemas\/Event\/characters","kind":"symbol","url":"\/documentation\/marvelservice\/components\/schemas\/event\/characters","title":"characters","role":"symbol","abstract":[{"type":"text","text":"A resource list containing the characters which appear in this event."}],"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":{"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"}}} |