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

{"sections":[],"abstract":[{"text":"Fetches lists of comics.","type":"text"}],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/MarvelService\/documentation\/MarvelService\/APIProtocol\/getComics(query:headers:)"},"primaryContentSections":[{"declarations":[{"languages":["swift"],"tokens":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"getComics","kind":"identifier"},{"text":"(","kind":"text"},{"text":"query","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"Operations","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations","kind":"typeIdentifier","preciseIdentifier":"s:13MarvelService10OperationsO"},{"text":".","kind":"text"},{"text":"getComics","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getComics","kind":"typeIdentifier","preciseIdentifier":"s:13MarvelService10OperationsO9getComicsO"},{"text":".","kind":"text"},{"text":"Input","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getComics\/Input","kind":"typeIdentifier","preciseIdentifier":"s:13MarvelService10OperationsO9getComicsO5InputV"},{"text":".","kind":"text"},{"text":"Query","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getComics\/Input\/Query-swift.struct","kind":"typeIdentifier","preciseIdentifier":"s:13MarvelService10OperationsO9getComicsO5InputV5QueryV"},{"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":"getComics","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getComics","kind":"typeIdentifier","preciseIdentifier":"s:13MarvelService10OperationsO9getComicsO"},{"text":".","kind":"text"},{"text":"Input","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getComics\/Input","kind":"typeIdentifier","preciseIdentifier":"s:13MarvelService10OperationsO9getComicsO5InputV"},{"text":".","kind":"text"},{"text":"Headers","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getComics\/Input\/Headers-swift.struct","kind":"typeIdentifier","preciseIdentifier":"s:13MarvelService10OperationsO9getComicsO5InputV7HeadersV"},{"text":" = .init()) ","kind":"text"},{"text":"async","kind":"keyword"},{"text":" ","kind":"text"},{"text":"throws","kind":"keyword"},{"text":" -> ","kind":"text"},{"text":"Operations","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations","kind":"typeIdentifier","preciseIdentifier":"s:13MarvelService10OperationsO"},{"text":".","kind":"text"},{"text":"getComics","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getComics","kind":"typeIdentifier","preciseIdentifier":"s:13MarvelService10OperationsO9getComicsO"},{"text":".","kind":"text"},{"text":"Output","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getComics\/Output","kind":"typeIdentifier","preciseIdentifier":"s:13MarvelService10OperationsO9getComicsO6OutputO"}],"platforms":["macOS"]}],"kind":"declarations"},{"content":[{"anchor":"discussion","text":"Discussion","level":2,"type":"heading"},{"type":"paragraph","inlineContent":[{"text":"Fetches lists of comics with optional filters.","type":"text"}]},{"type":"aside","content":[{"inlineContent":[{"type":"text","text":"HTTP "},{"type":"codeVoice","code":"GET \/v1\/public\/comics"},{"type":"text","text":"."}],"type":"paragraph"}],"style":"note","name":"Remark"},{"type":"aside","content":[{"inlineContent":[{"type":"text","text":"Generated from "},{"type":"codeVoice","code":"#\/paths\/\/v1\/public\/comics\/get(getComics)"},{"type":"text","text":"."}],"type":"paragraph"}],"style":"note","name":"Remark"}],"kind":"content"}],"kind":"symbol","hierarchy":{"paths":[["doc:\/\/MarvelService\/documentation\/MarvelService","doc:\/\/MarvelService\/documentation\/MarvelService\/APIProtocol"]]},"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/marvelservice\/apiprotocol\/getcomics(query:headers:)"]}],"metadata":{"symbolKind":"method","role":"symbol","externalID":"s:13MarvelService11APIProtocolPAAE9getComics5query7headersAA10OperationsOADO6OutputOAI5InputV5QueryV_AM7HeadersVtYaKF","title":"getComics(query:headers:)","roleHeading":"Instance Method","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"getComics"},{"kind":"text","text":"("},{"kind":"externalParam","text":"query"},{"kind":"text","text":": "},{"preciseIdentifier":"s:13MarvelService10OperationsO","kind":"typeIdentifier","text":"Operations"},{"kind":"text","text":"."},{"preciseIdentifier":"s:13MarvelService10OperationsO9getComicsO","kind":"typeIdentifier","text":"getComics"},{"kind":"text","text":"."},{"preciseIdentifier":"s:13MarvelService10OperationsO9getComicsO5InputV","kind":"typeIdentifier","text":"Input"},{"kind":"text","text":"."},{"preciseIdentifier":"s:13MarvelService10OperationsO9getComicsO5InputV5QueryV","kind":"typeIdentifier","text":"Query"},{"kind":"text","text":", "},{"kind":"externalParam","text":"headers"},{"kind":"text","text":": "},{"preciseIdentifier":"s:13MarvelService10OperationsO","kind":"typeIdentifier","text":"Operations"},{"kind":"text","text":"."},{"preciseIdentifier":"s:13MarvelService10OperationsO9getComicsO","kind":"typeIdentifier","text":"getComics"},{"kind":"text","text":"."},{"preciseIdentifier":"s:13MarvelService10OperationsO9getComicsO5InputV","kind":"typeIdentifier","text":"Input"},{"kind":"text","text":"."},{"preciseIdentifier":"s:13MarvelService10OperationsO9getComicsO5InputV7HeadersV","kind":"typeIdentifier","text":"Headers"},{"kind":"text","text":") "},{"kind":"keyword","text":"async"},{"kind":"text","text":" "},{"kind":"keyword","text":"throws"},{"kind":"text","text":" -> "},{"preciseIdentifier":"s:13MarvelService10OperationsO","kind":"typeIdentifier","text":"Operations"},{"kind":"text","text":"."},{"preciseIdentifier":"s:13MarvelService10OperationsO9getComicsO","kind":"typeIdentifier","text":"getComics"},{"kind":"text","text":"."},{"preciseIdentifier":"s:13MarvelService10OperationsO9getComicsO6OutputO","kind":"typeIdentifier","text":"Output"}],"modules":[{"name":"MarvelService"}],"extendedModule":"MarvelService"},"schemaVersion":{"minor":3,"major":0,"patch":0},"references":{"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/getComics/Input/Query-swift.struct":{"abstract":[],"role":"symbol","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getComics\/Input\/Query-swift.struct","navigatorTitle":[{"text":"Query","kind":"identifier"}],"title":"Operations.getComics.Input.Query","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Query","kind":"identifier"}],"kind":"symbol","type":"topic","url":"\/documentation\/marvelservice\/operations\/getcomics\/input\/query-swift.struct"},"doc://MarvelService/documentation/MarvelService/Operations/getComics":{"navigatorTitle":[{"text":"getComics","kind":"identifier"}],"url":"\/documentation\/marvelservice\/operations\/getcomics","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getComics","fragments":[{"text":"enum","kind":"keyword"},{"kind":"text","text":" "},{"text":"getComics","kind":"identifier"}],"role":"symbol","type":"topic","abstract":[{"text":"Fetches lists of comics.","type":"text"}],"kind":"symbol","title":"Operations.getComics"},"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":{"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/APIProtocol/getComics(query:headers:)":{"title":"getComics(query:headers:)","abstract":[{"type":"text","text":"Fetches lists of comics."}],"url":"\/documentation\/marvelservice\/apiprotocol\/getcomics(query:headers:)","kind":"symbol","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/APIProtocol\/getComics(query:headers:)","type":"topic","role":"symbol","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"getComics","kind":"identifier"},{"text":"(","kind":"text"},{"text":"query","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"Operations","kind":"typeIdentifier","preciseIdentifier":"s:13MarvelService10OperationsO"},{"text":".","kind":"text"},{"text":"getComics","kind":"typeIdentifier","preciseIdentifier":"s:13MarvelService10OperationsO9getComicsO"},{"text":".","kind":"text"},{"text":"Input","kind":"typeIdentifier","preciseIdentifier":"s:13MarvelService10OperationsO9getComicsO5InputV"},{"text":".","kind":"text"},{"text":"Query","kind":"typeIdentifier","preciseIdentifier":"s:13MarvelService10OperationsO9getComicsO5InputV5QueryV"},{"text":", ","kind":"text"},{"text":"headers","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"Operations","kind":"typeIdentifier","preciseIdentifier":"s:13MarvelService10OperationsO"},{"text":".","kind":"text"},{"text":"getComics","kind":"typeIdentifier","preciseIdentifier":"s:13MarvelService10OperationsO9getComicsO"},{"text":".","kind":"text"},{"text":"Input","kind":"typeIdentifier","preciseIdentifier":"s:13MarvelService10OperationsO9getComicsO5InputV"},{"text":".","kind":"text"},{"text":"Headers","kind":"typeIdentifier","preciseIdentifier":"s:13MarvelService10OperationsO9getComicsO5InputV7HeadersV"},{"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":"getComics","kind":"typeIdentifier","preciseIdentifier":"s:13MarvelService10OperationsO9getComicsO"},{"text":".","kind":"text"},{"text":"Output","kind":"typeIdentifier","preciseIdentifier":"s:13MarvelService10OperationsO9getComicsO6OutputO"}]},"doc://MarvelService/documentation/MarvelService/Operations/getComics/Input/Headers-swift.struct":{"abstract":[],"role":"symbol","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getComics\/Input\/Headers-swift.struct","navigatorTitle":[{"text":"Headers","kind":"identifier"}],"title":"Operations.getComics.Input.Headers","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Headers","kind":"identifier"}],"kind":"symbol","url":"\/documentation\/marvelservice\/operations\/getcomics\/input\/headers-swift.struct","type":"topic"},"doc://MarvelService/documentation/MarvelService/Operations/getComics/Output":{"url":"\/documentation\/marvelservice\/operations\/getcomics\/output","title":"Operations.getComics.Output","navigatorTitle":[{"text":"Output","kind":"identifier"}],"type":"topic","abstract":[],"role":"symbol","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getComics\/Output","kind":"symbol","fragments":[{"text":"enum","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Output","kind":"identifier"}]},"doc://MarvelService/documentation/MarvelService/Operations/getComics/Input":{"abstract":[],"role":"symbol","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getComics\/Input","navigatorTitle":[{"text":"Input","kind":"identifier"}],"title":"Operations.getComics.Input","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Input","kind":"identifier"}],"kind":"symbol","url":"\/documentation\/marvelservice\/operations\/getcomics\/input","type":"topic"}}}