Files
marvel-service/docs/data/documentation/marvelservice/apiprotocol/getcomicsbyseriesid(path:query:headers:).json
T

1 line
17 KiB
JSON

{"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/marvelservice\/apiprotocol\/getcomicsbyseriesid(path:query:headers:)"]}],"schemaVersion":{"major":0,"minor":3,"patch":0},"hierarchy":{"paths":[["doc:\/\/MarvelService\/documentation\/MarvelService","doc:\/\/MarvelService\/documentation\/MarvelService\/APIProtocol"]]},"abstract":[{"type":"text","text":"Fetches lists of comics filtered by a series id."}],"kind":"symbol","metadata":{"modules":[{"name":"MarvelService"}],"fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"getComicsBySeriesId"},{"kind":"text","text":"("},{"kind":"externalParam","text":"path"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Operations","preciseIdentifier":"s:13MarvelService10OperationsO"},{"kind":"text","text":"."},{"kind":"typeIdentifier","text":"getComicsBySeriesId","preciseIdentifier":"s:13MarvelService10OperationsO19getComicsBySeriesIdO"},{"kind":"text","text":"."},{"kind":"typeIdentifier","text":"Input","preciseIdentifier":"s:13MarvelService10OperationsO19getComicsBySeriesIdO5InputV"},{"kind":"text","text":"."},{"kind":"typeIdentifier","text":"Path","preciseIdentifier":"s:13MarvelService10OperationsO19getComicsBySeriesIdO5InputV4PathV"},{"kind":"text","text":", "},{"kind":"externalParam","text":"query"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Operations","preciseIdentifier":"s:13MarvelService10OperationsO"},{"kind":"text","text":"."},{"kind":"typeIdentifier","text":"getComicsBySeriesId","preciseIdentifier":"s:13MarvelService10OperationsO19getComicsBySeriesIdO"},{"kind":"text","text":"."},{"kind":"typeIdentifier","text":"Input","preciseIdentifier":"s:13MarvelService10OperationsO19getComicsBySeriesIdO5InputV"},{"kind":"text","text":"."},{"kind":"typeIdentifier","text":"Query","preciseIdentifier":"s:13MarvelService10OperationsO19getComicsBySeriesIdO5InputV5QueryV"},{"kind":"text","text":", "},{"kind":"externalParam","text":"headers"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Operations","preciseIdentifier":"s:13MarvelService10OperationsO"},{"kind":"text","text":"."},{"kind":"typeIdentifier","text":"getComicsBySeriesId","preciseIdentifier":"s:13MarvelService10OperationsO19getComicsBySeriesIdO"},{"kind":"text","text":"."},{"kind":"typeIdentifier","text":"Input","preciseIdentifier":"s:13MarvelService10OperationsO19getComicsBySeriesIdO5InputV"},{"kind":"text","text":"."},{"kind":"typeIdentifier","text":"Headers","preciseIdentifier":"s:13MarvelService10OperationsO19getComicsBySeriesIdO5InputV7HeadersV"},{"kind":"text","text":") "},{"kind":"keyword","text":"async"},{"kind":"text","text":" "},{"kind":"keyword","text":"throws"},{"kind":"text","text":" -> "},{"kind":"typeIdentifier","text":"Operations","preciseIdentifier":"s:13MarvelService10OperationsO"},{"kind":"text","text":"."},{"kind":"typeIdentifier","text":"getComicsBySeriesId","preciseIdentifier":"s:13MarvelService10OperationsO19getComicsBySeriesIdO"},{"kind":"text","text":"."},{"kind":"typeIdentifier","text":"Output","preciseIdentifier":"s:13MarvelService10OperationsO19getComicsBySeriesIdO6OutputO"}],"externalID":"s:13MarvelService11APIProtocolPAAE19getComicsBySeriesId4path5query7headersAA10OperationsOADO6OutputOAJ5InputV4PathV_AN5QueryVAN7HeadersVtYaKF","extendedModule":"MarvelService","roleHeading":"Instance Method","role":"symbol","symbolKind":"method","title":"getComicsBySeriesId(path:query:headers:)"},"sections":[],"primaryContentSections":[{"kind":"declarations","declarations":[{"platforms":["macOS"],"languages":["swift"],"tokens":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"getComicsBySeriesId"},{"kind":"text","text":"("},{"kind":"externalParam","text":"path"},{"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\/getComicsBySeriesId","preciseIdentifier":"s:13MarvelService10OperationsO19getComicsBySeriesIdO","text":"getComicsBySeriesId"},{"kind":"text","text":"."},{"kind":"typeIdentifier","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getComicsBySeriesId\/Input","preciseIdentifier":"s:13MarvelService10OperationsO19getComicsBySeriesIdO5InputV","text":"Input"},{"kind":"text","text":"."},{"kind":"typeIdentifier","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getComicsBySeriesId\/Input\/Path-swift.struct","preciseIdentifier":"s:13MarvelService10OperationsO19getComicsBySeriesIdO5InputV4PathV","text":"Path"},{"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\/getComicsBySeriesId","preciseIdentifier":"s:13MarvelService10OperationsO19getComicsBySeriesIdO","text":"getComicsBySeriesId"},{"kind":"text","text":"."},{"kind":"typeIdentifier","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getComicsBySeriesId\/Input","preciseIdentifier":"s:13MarvelService10OperationsO19getComicsBySeriesIdO5InputV","text":"Input"},{"kind":"text","text":"."},{"kind":"typeIdentifier","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getComicsBySeriesId\/Input\/Query-swift.struct","preciseIdentifier":"s:13MarvelService10OperationsO19getComicsBySeriesIdO5InputV5QueryV","text":"Query"},{"kind":"text","text":" = .init(), "},{"kind":"externalParam","text":"headers"},{"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\/getComicsBySeriesId","preciseIdentifier":"s:13MarvelService10OperationsO19getComicsBySeriesIdO","text":"getComicsBySeriesId"},{"kind":"text","text":"."},{"kind":"typeIdentifier","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getComicsBySeriesId\/Input","preciseIdentifier":"s:13MarvelService10OperationsO19getComicsBySeriesIdO5InputV","text":"Input"},{"kind":"text","text":"."},{"kind":"typeIdentifier","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getComicsBySeriesId\/Input\/Headers-swift.struct","preciseIdentifier":"s:13MarvelService10OperationsO19getComicsBySeriesIdO5InputV7HeadersV","text":"Headers"},{"kind":"text","text":" = .init()) "},{"kind":"keyword","text":"async"},{"kind":"text","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\/getComicsBySeriesId","preciseIdentifier":"s:13MarvelService10OperationsO19getComicsBySeriesIdO","text":"getComicsBySeriesId"},{"kind":"text","text":"."},{"kind":"typeIdentifier","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getComicsBySeriesId\/Output","preciseIdentifier":"s:13MarvelService10OperationsO19getComicsBySeriesIdO6OutputO","text":"Output"}]}]},{"content":[{"text":"Discussion","anchor":"discussion","level":2,"type":"heading"},{"inlineContent":[{"text":"Fetches lists of comics which are published as part of a specific series, with optional filters.","type":"text"}],"type":"paragraph"},{"name":"Remark","style":"note","type":"aside","content":[{"type":"paragraph","inlineContent":[{"text":"HTTP ","type":"text"},{"code":"GET \/v1\/public\/series\/{seriesId}\/comics","type":"codeVoice"},{"text":".","type":"text"}]}]},{"name":"Remark","style":"note","type":"aside","content":[{"type":"paragraph","inlineContent":[{"text":"Generated from ","type":"text"},{"code":"#\/paths\/\/v1\/public\/series\/{seriesId}\/comics\/get(getComicsBySeriesId)","type":"codeVoice"},{"text":".","type":"text"}]}]}],"kind":"content"}],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/MarvelService\/documentation\/MarvelService\/APIProtocol\/getComicsBySeriesId(path: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/APIProtocol/getComicsBySeriesId(path:query:headers:)":{"type":"topic","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/APIProtocol\/getComicsBySeriesId(path:query:headers:)","url":"\/documentation\/marvelservice\/apiprotocol\/getcomicsbyseriesid(path:query:headers:)","kind":"symbol","role":"symbol","title":"getComicsBySeriesId(path:query:headers:)","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"getComicsBySeriesId"},{"kind":"text","text":"("},{"kind":"externalParam","text":"path"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:13MarvelService10OperationsO","text":"Operations"},{"kind":"text","text":"."},{"kind":"typeIdentifier","preciseIdentifier":"s:13MarvelService10OperationsO19getComicsBySeriesIdO","text":"getComicsBySeriesId"},{"kind":"text","text":"."},{"kind":"typeIdentifier","preciseIdentifier":"s:13MarvelService10OperationsO19getComicsBySeriesIdO5InputV","text":"Input"},{"kind":"text","text":"."},{"kind":"typeIdentifier","preciseIdentifier":"s:13MarvelService10OperationsO19getComicsBySeriesIdO5InputV4PathV","text":"Path"},{"kind":"text","text":", "},{"kind":"externalParam","text":"query"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:13MarvelService10OperationsO","text":"Operations"},{"kind":"text","text":"."},{"kind":"typeIdentifier","preciseIdentifier":"s:13MarvelService10OperationsO19getComicsBySeriesIdO","text":"getComicsBySeriesId"},{"kind":"text","text":"."},{"kind":"typeIdentifier","preciseIdentifier":"s:13MarvelService10OperationsO19getComicsBySeriesIdO5InputV","text":"Input"},{"kind":"text","text":"."},{"kind":"typeIdentifier","preciseIdentifier":"s:13MarvelService10OperationsO19getComicsBySeriesIdO5InputV5QueryV","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:13MarvelService10OperationsO19getComicsBySeriesIdO","text":"getComicsBySeriesId"},{"kind":"text","text":"."},{"kind":"typeIdentifier","preciseIdentifier":"s:13MarvelService10OperationsO19getComicsBySeriesIdO5InputV","text":"Input"},{"kind":"text","text":"."},{"kind":"typeIdentifier","preciseIdentifier":"s:13MarvelService10OperationsO19getComicsBySeriesIdO5InputV7HeadersV","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:13MarvelService10OperationsO19getComicsBySeriesIdO","text":"getComicsBySeriesId"},{"kind":"text","text":"."},{"kind":"typeIdentifier","preciseIdentifier":"s:13MarvelService10OperationsO19getComicsBySeriesIdO6OutputO","text":"Output"}],"abstract":[{"text":"Fetches lists of comics filtered by a series id.","type":"text"}]},"doc://MarvelService/documentation/MarvelService/Operations/getComicsBySeriesId/Input/Headers-swift.struct":{"type":"topic","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getComicsBySeriesId\/Input\/Headers-swift.struct","url":"\/documentation\/marvelservice\/operations\/getcomicsbyseriesid\/input\/headers-swift.struct","kind":"symbol","navigatorTitle":[{"kind":"identifier","text":"Headers"}],"role":"symbol","title":"Operations.getComicsBySeriesId.Input.Headers","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"Headers"}],"abstract":[]},"doc://MarvelService/documentation/MarvelService/Operations/getComicsBySeriesId":{"type":"topic","url":"\/documentation\/marvelservice\/operations\/getcomicsbyseriesid","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getComicsBySeriesId","kind":"symbol","navigatorTitle":[{"kind":"identifier","text":"getComicsBySeriesId"}],"role":"symbol","title":"Operations.getComicsBySeriesId","fragments":[{"kind":"keyword","text":"enum"},{"kind":"text","text":" "},{"kind":"identifier","text":"getComicsBySeriesId"}],"abstract":[{"type":"text","text":"Fetches lists of comics filtered by a series id."}]},"doc://MarvelService/documentation/MarvelService/Operations/getComicsBySeriesId/Input/Query-swift.struct":{"navigatorTitle":[{"text":"Query","kind":"identifier"}],"url":"\/documentation\/marvelservice\/operations\/getcomicsbyseriesid\/input\/query-swift.struct","kind":"symbol","title":"Operations.getComicsBySeriesId.Input.Query","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getComicsBySeriesId\/Input\/Query-swift.struct","role":"symbol","type":"topic","abstract":[],"fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Query","kind":"identifier"}]},"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":{"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/getComicsBySeriesId/Input/Path-swift.struct":{"identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getComicsBySeriesId\/Input\/Path-swift.struct","type":"topic","url":"\/documentation\/marvelservice\/operations\/getcomicsbyseriesid\/input\/path-swift.struct","kind":"symbol","navigatorTitle":[{"kind":"identifier","text":"Path"}],"role":"symbol","title":"Operations.getComicsBySeriesId.Input.Path","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"Path"}],"abstract":[]},"doc://MarvelService/documentation/MarvelService/Operations/getComicsBySeriesId/Input":{"navigatorTitle":[{"text":"Input","kind":"identifier"}],"url":"\/documentation\/marvelservice\/operations\/getcomicsbyseriesid\/input","kind":"symbol","title":"Operations.getComicsBySeriesId.Input","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getComicsBySeriesId\/Input","role":"symbol","type":"topic","abstract":[],"fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Input","kind":"identifier"}]},"doc://MarvelService/documentation/MarvelService/Operations/getComicsBySeriesId/Output":{"type":"topic","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getComicsBySeriesId\/Output","fragments":[{"kind":"keyword","text":"enum"},{"kind":"text","text":" "},{"kind":"identifier","text":"Output"}],"url":"\/documentation\/marvelservice\/operations\/getcomicsbyseriesid\/output","title":"Operations.getComicsBySeriesId.Output","kind":"symbol","role":"symbol","navigatorTitle":[{"kind":"identifier","text":"Output"}],"abstract":[]}}}