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

{"sections":[],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/marvelservice\/apiprotocol\/getcharacters(query:headers:)"]}],"primaryContentSections":[{"kind":"declarations","declarations":[{"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","preciseIdentifier":"s:13MarvelService10OperationsO","kind":"typeIdentifier","text":"Operations"},{"text":".","kind":"text"},{"text":"getCharacters","kind":"typeIdentifier","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getCharacters","preciseIdentifier":"s:13MarvelService10OperationsO13getCharactersO"},{"text":".","kind":"text"},{"text":"Input","kind":"typeIdentifier","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getCharacters\/Input","preciseIdentifier":"s:13MarvelService10OperationsO13getCharactersO5InputV"},{"text":".","kind":"text"},{"text":"Query","kind":"typeIdentifier","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getCharacters\/Input\/Query-swift.struct","preciseIdentifier":"s:13MarvelService10OperationsO13getCharactersO5InputV5QueryV"},{"text":" = .init(), ","kind":"text"},{"text":"headers","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"Operations","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations","kind":"typeIdentifier","preciseIdentifier":"s:13MarvelService10OperationsO"},{"text":".","kind":"text"},{"text":"getCharacters","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getCharacters","kind":"typeIdentifier","preciseIdentifier":"s:13MarvelService10OperationsO13getCharactersO"},{"kind":"text","text":"."},{"identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getCharacters\/Input","preciseIdentifier":"s:13MarvelService10OperationsO13getCharactersO5InputV","kind":"typeIdentifier","text":"Input"},{"text":".","kind":"text"},{"text":"Headers","kind":"typeIdentifier","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getCharacters\/Input\/Headers-swift.struct","preciseIdentifier":"s:13MarvelService10OperationsO13getCharactersO5InputV7HeadersV"},{"text":" = .init()) ","kind":"text"},{"text":"async","kind":"keyword"},{"text":" ","kind":"text"},{"text":"throws","kind":"keyword"},{"text":" -> ","kind":"text"},{"text":"Operations","kind":"typeIdentifier","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations","preciseIdentifier":"s:13MarvelService10OperationsO"},{"text":".","kind":"text"},{"text":"getCharacters","kind":"typeIdentifier","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getCharacters","preciseIdentifier":"s:13MarvelService10OperationsO13getCharactersO"},{"text":".","kind":"text"},{"text":"Output","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getCharacters\/Output","kind":"typeIdentifier","preciseIdentifier":"s:13MarvelService10OperationsO13getCharactersO6OutputO"}],"platforms":["macOS"],"languages":["swift"]}]},{"kind":"content","content":[{"type":"heading","anchor":"discussion","level":2,"text":"Discussion"},{"type":"paragraph","inlineContent":[{"text":"Fetches lists of comic characters with optional filters.","type":"text"}]},{"name":"Remark","type":"aside","style":"note","content":[{"inlineContent":[{"type":"text","text":"HTTP "},{"type":"codeVoice","code":"GET \/v1\/public\/characters"},{"type":"text","text":"."}],"type":"paragraph"}]},{"name":"Remark","type":"aside","style":"note","content":[{"inlineContent":[{"type":"text","text":"Generated from "},{"type":"codeVoice","code":"#\/paths\/\/v1\/public\/characters\/get(getCharacters)"},{"type":"text","text":"."}],"type":"paragraph"}]}]}],"schemaVersion":{"patch":0,"minor":3,"major":0},"abstract":[{"text":"Fetches lists of characters.","type":"text"}],"hierarchy":{"paths":[["doc:\/\/MarvelService\/documentation\/MarvelService","doc:\/\/MarvelService\/documentation\/MarvelService\/APIProtocol"]]},"identifier":{"url":"doc:\/\/MarvelService\/documentation\/MarvelService\/APIProtocol\/getCharacters(query:headers:)","interfaceLanguage":"swift"},"kind":"symbol","metadata":{"title":"getCharacters(query:headers:)","externalID":"s:13MarvelService11APIProtocolPAAE13getCharacters5query7headersAA10OperationsOADO6OutputOAI5InputV5QueryV_AM7HeadersVtYaKF","role":"symbol","modules":[{"name":"MarvelService"}],"roleHeading":"Instance Method","symbolKind":"method","extendedModule":"MarvelService","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"}]},"references":{"doc://MarvelService/documentation/MarvelService/Operations/getCharacters/Input/Headers-swift.struct":{"title":"Operations.getCharacters.Input.Headers","abstract":[],"url":"\/documentation\/marvelservice\/operations\/getcharacters\/input\/headers-swift.struct","navigatorTitle":[{"text":"Headers","kind":"identifier"}],"kind":"symbol","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getCharacters\/Input\/Headers-swift.struct","type":"topic","role":"symbol","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Headers","kind":"identifier"}]},"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":{"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/Operations/getCharacters/Output":{"abstract":[],"role":"symbol","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getCharacters\/Output","navigatorTitle":[{"text":"Output","kind":"identifier"}],"title":"Operations.getCharacters.Output","fragments":[{"kind":"keyword","text":"enum"},{"kind":"text","text":" "},{"kind":"identifier","text":"Output"}],"kind":"symbol","url":"\/documentation\/marvelservice\/operations\/getcharacters\/output","type":"topic"},"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/APIProtocol":{"url":"\/documentation\/marvelservice\/apiprotocol","title":"APIProtocol","navigatorTitle":[{"text":"APIProtocol","kind":"identifier"}],"type":"topic","abstract":[{"type":"text","text":"A type that performs HTTP operations defined by the OpenAPI document."}],"role":"symbol","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/APIProtocol","kind":"symbol","fragments":[{"text":"protocol","kind":"keyword"},{"text":" ","kind":"text"},{"text":"APIProtocol","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/APIProtocol/getCharacters(query:headers:)":{"title":"getCharacters(query:headers:)","abstract":[{"type":"text","text":"Fetches lists of characters."}],"url":"\/documentation\/marvelservice\/apiprotocol\/getcharacters(query:headers:)","kind":"symbol","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/APIProtocol\/getCharacters(query:headers:)","type":"topic","role":"symbol","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"}]},"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"}}}