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

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