marvel-service/docs/data/documentation/marvelservice/client/getcharacters(query:headers:).json

{"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/MarvelService\/documentation\/MarvelService\/Client\/getCharacters(query:headers:)"},"kind":"symbol","schemaVersion":{"major":0,"minor":3,"patch":0},"hierarchy":{"paths":[["doc:\/\/MarvelService\/documentation\/MarvelService","doc:\/\/MarvelService\/documentation\/MarvelService\/Client"]]},"metadata":{"fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"getCharacters","kind":"identifier"},{"text":"(","kind":"text"},{"text":"query","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"Operations","kind":"typeIdentifier","preciseIdentifier":"s:13MarvelService10OperationsO"},{"text":".","kind":"text"},{"text":"getCharacters","kind":"typeIdentifier","preciseIdentifier":"s:13MarvelService10OperationsO13getCharactersO"},{"text":".","kind":"text"},{"text":"Input","kind":"typeIdentifier","preciseIdentifier":"s:13MarvelService10OperationsO13getCharactersO5InputV"},{"text":".","kind":"text"},{"text":"Query","kind":"typeIdentifier","preciseIdentifier":"s:13MarvelService10OperationsO13getCharactersO5InputV5QueryV"},{"text":", ","kind":"text"},{"text":"headers","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"Operations","kind":"typeIdentifier","preciseIdentifier":"s:13MarvelService10OperationsO"},{"text":".","kind":"text"},{"text":"getCharacters","kind":"typeIdentifier","preciseIdentifier":"s:13MarvelService10OperationsO13getCharactersO"},{"text":".","kind":"text"},{"text":"Input","kind":"typeIdentifier","preciseIdentifier":"s:13MarvelService10OperationsO13getCharactersO5InputV"},{"text":".","kind":"text"},{"text":"Headers","kind":"typeIdentifier","preciseIdentifier":"s:13MarvelService10OperationsO13getCharactersO5InputV7HeadersV"},{"text":") ","kind":"text"},{"text":"async","kind":"keyword"},{"text":" ","kind":"text"},{"text":"throws","kind":"keyword"},{"text":" -> ","kind":"text"},{"text":"Operations","kind":"typeIdentifier","preciseIdentifier":"s:13MarvelService10OperationsO"},{"text":".","kind":"text"},{"text":"getCharacters","kind":"typeIdentifier","preciseIdentifier":"s:13MarvelService10OperationsO13getCharactersO"},{"text":".","kind":"text"},{"text":"Output","kind":"typeIdentifier","preciseIdentifier":"s:13MarvelService10OperationsO13getCharactersO6OutputO"}],"modules":[{"name":"MarvelService"}],"roleHeading":"Instance Method","role":"symbol","title":"getCharacters(query:headers:)","externalID":"s:13MarvelService11APIProtocolPAAE13getCharacters5query7headersAA10OperationsOADO6OutputOAI5InputV5QueryV_AM7HeadersVtYaKF::SYNTHESIZED::s:13MarvelService6ClientV","symbolKind":"method","extendedModule":"MarvelService"},"sections":[],"primaryContentSections":[{"kind":"declarations","declarations":[{"languages":["swift"],"tokens":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"getCharacters","kind":"identifier"},{"text":"(","kind":"text"},{"text":"query","kind":"externalParam"},{"text":": ","kind":"text"},{"identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations","text":"Operations","preciseIdentifier":"s:13MarvelService10OperationsO","kind":"typeIdentifier"},{"text":".","kind":"text"},{"identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getCharacters","text":"getCharacters","preciseIdentifier":"s:13MarvelService10OperationsO13getCharactersO","kind":"typeIdentifier"},{"text":".","kind":"text"},{"identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getCharacters\/Input","text":"Input","preciseIdentifier":"s:13MarvelService10OperationsO13getCharactersO5InputV","kind":"typeIdentifier"},{"text":".","kind":"text"},{"identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getCharacters\/Input\/Query-swift.struct","text":"Query","preciseIdentifier":"s:13MarvelService10OperationsO13getCharactersO5InputV5QueryV","kind":"typeIdentifier"},{"text":" = .init(), ","kind":"text"},{"text":"headers","kind":"externalParam"},{"text":": ","kind":"text"},{"identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations","text":"Operations","preciseIdentifier":"s:13MarvelService10OperationsO","kind":"typeIdentifier"},{"text":".","kind":"text"},{"identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getCharacters","text":"getCharacters","preciseIdentifier":"s:13MarvelService10OperationsO13getCharactersO","kind":"typeIdentifier"},{"text":".","kind":"text"},{"identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getCharacters\/Input","text":"Input","preciseIdentifier":"s:13MarvelService10OperationsO13getCharactersO5InputV","kind":"typeIdentifier"},{"text":".","kind":"text"},{"identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getCharacters\/Input\/Headers-swift.struct","text":"Headers","preciseIdentifier":"s:13MarvelService10OperationsO13getCharactersO5InputV7HeadersV","kind":"typeIdentifier"},{"text":" = .init()) ","kind":"text"},{"text":"async","kind":"keyword"},{"text":" ","kind":"text"},{"text":"throws","kind":"keyword"},{"text":" -> ","kind":"text"},{"identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations","text":"Operations","preciseIdentifier":"s:13MarvelService10OperationsO","kind":"typeIdentifier"},{"text":".","kind":"text"},{"identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getCharacters","text":"getCharacters","preciseIdentifier":"s:13MarvelService10OperationsO13getCharactersO","kind":"typeIdentifier"},{"text":".","kind":"text"},{"identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getCharacters\/Output","text":"Output","preciseIdentifier":"s:13MarvelService10OperationsO13getCharactersO6OutputO","kind":"typeIdentifier"}],"platforms":["macOS"]}]},{"kind":"content","content":[{"level":2,"type":"heading","text":"Discussion","anchor":"discussion"},{"type":"paragraph","inlineContent":[{"text":"Fetches lists of comic characters with optional filters.","type":"text"}]},{"type":"aside","content":[{"inlineContent":[{"type":"text","text":"HTTP "},{"type":"codeVoice","code":"GET \/v1\/public\/characters"},{"type":"text","text":"."}],"type":"paragraph"}],"style":"note","name":"Remark"},{"type":"aside","content":[{"inlineContent":[{"type":"text","text":"Generated from "},{"type":"codeVoice","code":"#\/paths\/\/v1\/public\/characters\/get(getCharacters)"},{"type":"text","text":"."}],"type":"paragraph"}],"style":"note","name":"Remark"}]}],"abstract":[{"type":"text","text":"Fetches lists of characters."}],"variants":[{"paths":["\/documentation\/marvelservice\/client\/getcharacters(query:headers:)"],"traits":[{"interfaceLanguage":"swift"}]}],"references":{"doc://MarvelService/documentation/MarvelService/Operations/getCharacters/Output":{"type":"topic","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getCharacters\/Output","fragments":[{"kind":"keyword","text":"enum"},{"kind":"text","text":" "},{"kind":"identifier","text":"Output"}],"url":"\/documentation\/marvelservice\/operations\/getcharacters\/output","title":"Operations.getCharacters.Output","kind":"symbol","role":"symbol","navigatorTitle":[{"kind":"identifier","text":"Output"}],"abstract":[]},"doc://MarvelService/documentation/MarvelService":{"url":"\/documentation\/marvelservice","kind":"symbol","title":"MarvelService","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService","role":"collection","type":"topic","abstract":[{"text":"A library that allows the developer to interact with the ","type":"text"},{"type":"strong","inlineContent":[{"text":"Marvel Comics API","type":"text"}]},{"text":" backend service.","type":"text"}]},"doc://MarvelService/documentation/MarvelService/Client":{"type":"topic","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Client","url":"\/documentation\/marvelservice\/client","kind":"symbol","navigatorTitle":[{"text":"Client","kind":"identifier"}],"role":"symbol","title":"Client","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Client","kind":"identifier"}],"abstract":[{"type":"text","text":"The Marvel Comics RESTful API."}]},"doc://MarvelService/documentation/MarvelService/Operations/getCharacters/Input/Query-swift.struct":{"type":"topic","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getCharacters\/Input\/Query-swift.struct","url":"\/documentation\/marvelservice\/operations\/getcharacters\/input\/query-swift.struct","kind":"symbol","navigatorTitle":[{"text":"Query","kind":"identifier"}],"role":"symbol","title":"Operations.getCharacters.Input.Query","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Query","kind":"identifier"}],"abstract":[]},"doc://MarvelService/documentation/MarvelService/Client/getCharacters(query:headers:)":{"type":"topic","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Client\/getCharacters(query:headers:)","url":"\/documentation\/marvelservice\/client\/getcharacters(query:headers:)","kind":"symbol","role":"symbol","title":"getCharacters(query:headers:)","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"getCharacters","kind":"identifier"},{"text":"(","kind":"text"},{"text":"query","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"Operations","kind":"typeIdentifier","preciseIdentifier":"s:13MarvelService10OperationsO"},{"text":".","kind":"text"},{"text":"getCharacters","kind":"typeIdentifier","preciseIdentifier":"s:13MarvelService10OperationsO13getCharactersO"},{"text":".","kind":"text"},{"text":"Input","kind":"typeIdentifier","preciseIdentifier":"s:13MarvelService10OperationsO13getCharactersO5InputV"},{"text":".","kind":"text"},{"text":"Query","kind":"typeIdentifier","preciseIdentifier":"s:13MarvelService10OperationsO13getCharactersO5InputV5QueryV"},{"text":", ","kind":"text"},{"text":"headers","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"Operations","kind":"typeIdentifier","preciseIdentifier":"s:13MarvelService10OperationsO"},{"text":".","kind":"text"},{"text":"getCharacters","kind":"typeIdentifier","preciseIdentifier":"s:13MarvelService10OperationsO13getCharactersO"},{"text":".","kind":"text"},{"text":"Input","kind":"typeIdentifier","preciseIdentifier":"s:13MarvelService10OperationsO13getCharactersO5InputV"},{"text":".","kind":"text"},{"text":"Headers","kind":"typeIdentifier","preciseIdentifier":"s:13MarvelService10OperationsO13getCharactersO5InputV7HeadersV"},{"text":") ","kind":"text"},{"text":"async","kind":"keyword"},{"text":" ","kind":"text"},{"text":"throws","kind":"keyword"},{"text":" -> ","kind":"text"},{"text":"Operations","kind":"typeIdentifier","preciseIdentifier":"s:13MarvelService10OperationsO"},{"text":".","kind":"text"},{"text":"getCharacters","kind":"typeIdentifier","preciseIdentifier":"s:13MarvelService10OperationsO13getCharactersO"},{"text":".","kind":"text"},{"text":"Output","kind":"typeIdentifier","preciseIdentifier":"s:13MarvelService10OperationsO13getCharactersO6OutputO"}],"abstract":[{"type":"text","text":"Fetches lists of characters."}]},"doc://MarvelService/documentation/MarvelService/Operations/getCharacters/Input":{"type":"topic","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getCharacters\/Input","url":"\/documentation\/marvelservice\/operations\/getcharacters\/input","kind":"symbol","navigatorTitle":[{"text":"Input","kind":"identifier"}],"role":"symbol","title":"Operations.getCharacters.Input","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Input","kind":"identifier"}],"abstract":[]},"doc://MarvelService/documentation/MarvelService/Operations/getCharacters":{"type":"topic","fragments":[{"kind":"keyword","text":"enum"},{"kind":"text","text":" "},{"kind":"identifier","text":"getCharacters"}],"abstract":[{"type":"text","text":"Fetches lists of characters."}],"navigatorTitle":[{"kind":"identifier","text":"getCharacters"}],"kind":"symbol","role":"symbol","title":"Operations.getCharacters","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getCharacters","url":"\/documentation\/marvelservice\/operations\/getcharacters"},"doc://MarvelService/documentation/MarvelService/Operations":{"navigatorTitle":[{"kind":"identifier","text":"Operations"}],"url":"\/documentation\/marvelservice\/operations","kind":"symbol","title":"Operations","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations","role":"symbol","type":"topic","abstract":[{"type":"text","text":"API operations, with input and output types, generated from "},{"code":"#\/paths","type":"codeVoice"},{"text":" in the OpenAPI document.","type":"text"}],"fragments":[{"kind":"keyword","text":"enum"},{"kind":"text","text":" "},{"kind":"identifier","text":"Operations"}]},"doc://MarvelService/documentation/MarvelService/Operations/getCharacters/Input/Headers-swift.struct":{"type":"topic","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getCharacters\/Input\/Headers-swift.struct","url":"\/documentation\/marvelservice\/operations\/getcharacters\/input\/headers-swift.struct","kind":"symbol","navigatorTitle":[{"text":"Headers","kind":"identifier"}],"role":"symbol","title":"Operations.getCharacters.Input.Headers","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Headers","kind":"identifier"}],"abstract":[]}}}