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

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