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
5.6 KiB
JSON
1 line
5.6 KiB
JSON
{"sections":[],"abstract":[{"text":"Return only characters which appear in the specified comics (accepts a comma-separated list of ids).","type":"text"}],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getCharacters\/Input\/Query-swift.struct\/comics"},"primaryContentSections":[{"declarations":[{"platforms":["macOS"],"languages":["swift"],"tokens":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"comics","kind":"identifier"},{"text":": [","kind":"text"},{"preciseIdentifier":"s:Si","text":"Int","kind":"typeIdentifier"},{"text":"]?","kind":"text"}]}],"kind":"declarations"},{"content":[{"level":2,"text":"Discussion","type":"heading","anchor":"discussion"},{"style":"note","type":"aside","content":[{"type":"paragraph","inlineContent":[{"text":"Generated from ","type":"text"},{"code":"#\/paths\/v1\/public\/characters\/GET\/query\/comics","type":"codeVoice"},{"text":".","type":"text"}]}],"name":"Remark"}],"kind":"content"}],"kind":"symbol","hierarchy":{"paths":[["doc:\/\/MarvelService\/documentation\/MarvelService","doc:\/\/MarvelService\/documentation\/MarvelService\/Operations","doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getCharacters","doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getCharacters\/Input","doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getCharacters\/Input\/Query-swift.struct"]]},"variants":[{"paths":["\/documentation\/marvelservice\/operations\/getcharacters\/input\/query-swift.struct\/comics"],"traits":[{"interfaceLanguage":"swift"}]}],"metadata":{"symbolKind":"property","role":"symbol","externalID":"s:13MarvelService10OperationsO13getCharactersO5InputV5QueryV6comicsSaySiGSgvp","roleHeading":"Instance Property","title":"comics","fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"comics","kind":"identifier"},{"text":": [","kind":"text"},{"preciseIdentifier":"s:Si","text":"Int","kind":"typeIdentifier"},{"text":"]?","kind":"text"}],"modules":[{"name":"MarvelService"}]},"schemaVersion":{"minor":3,"patch":0,"major":0},"references":{"doc://MarvelService/documentation/MarvelService/Operations/getCharacters":{"url":"\/documentation\/marvelservice\/operations\/getcharacters","title":"Operations.getCharacters","navigatorTitle":[{"text":"getCharacters","kind":"identifier"}],"type":"topic","abstract":[{"type":"text","text":"Fetches lists of characters."}],"role":"symbol","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getCharacters","kind":"symbol","fragments":[{"text":"enum","kind":"keyword"},{"text":" ","kind":"text"},{"text":"getCharacters","kind":"identifier"}]},"doc://MarvelService/documentation/MarvelService/Operations":{"fragments":[{"text":"enum","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Operations","kind":"identifier"}],"identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations","kind":"symbol","navigatorTitle":[{"kind":"identifier","text":"Operations"}],"url":"\/documentation\/marvelservice\/operations","title":"Operations","role":"symbol","abstract":[{"text":"API operations, with input and output types, generated from ","type":"text"},{"type":"codeVoice","code":"#\/paths"},{"type":"text","text":" in the OpenAPI document."}],"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/documentation/MarvelService/Operations/getCharacters/Input":{"url":"\/documentation\/marvelservice\/operations\/getcharacters\/input","title":"Operations.getCharacters.Input","navigatorTitle":[{"text":"Input","kind":"identifier"}],"type":"topic","abstract":[],"role":"symbol","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getCharacters\/Input","kind":"symbol","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Input","kind":"identifier"}]},"doc://MarvelService/documentation/MarvelService/Operations/getCharacters/Input/Query-swift.struct":{"url":"\/documentation\/marvelservice\/operations\/getcharacters\/input\/query-swift.struct","title":"Operations.getCharacters.Input.Query","navigatorTitle":[{"text":"Query","kind":"identifier"}],"type":"topic","abstract":[],"role":"symbol","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getCharacters\/Input\/Query-swift.struct","kind":"symbol","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Query","kind":"identifier"}]},"doc://MarvelService/documentation/MarvelService/Operations/getCharacters/Input/Query-swift.struct/comics":{"url":"\/documentation\/marvelservice\/operations\/getcharacters\/input\/query-swift.struct\/comics","title":"comics","type":"topic","abstract":[{"type":"text","text":"Return only characters which appear in the specified comics (accepts a comma-separated list of ids)."}],"role":"symbol","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getCharacters\/Input\/Query-swift.struct\/comics","kind":"symbol","fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"comics","kind":"identifier"},{"text":": [","kind":"text"},{"preciseIdentifier":"s:Si","text":"Int","kind":"typeIdentifier"},{"text":"]?","kind":"text"}]}}} |