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

{"metadata":{"role":"symbol","title":"getCharactersByStoryId(path:query:headers:)","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"getCharactersByStoryId"},{"kind":"text","text":"("},{"kind":"externalParam","text":"path"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:13MarvelService10OperationsO","text":"Operations"},{"kind":"text","text":"."},{"kind":"typeIdentifier","preciseIdentifier":"s:13MarvelService10OperationsO22getCharactersByStoryIdO","text":"getCharactersByStoryId"},{"kind":"text","text":"."},{"kind":"typeIdentifier","preciseIdentifier":"s:13MarvelService10OperationsO22getCharactersByStoryIdO5InputV","text":"Input"},{"kind":"text","text":"."},{"kind":"typeIdentifier","preciseIdentifier":"s:13MarvelService10OperationsO22getCharactersByStoryIdO5InputV4PathV","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:13MarvelService10OperationsO22getCharactersByStoryIdO","text":"getCharactersByStoryId"},{"kind":"text","text":"."},{"kind":"typeIdentifier","preciseIdentifier":"s:13MarvelService10OperationsO22getCharactersByStoryIdO5InputV","text":"Input"},{"kind":"text","text":"."},{"kind":"typeIdentifier","preciseIdentifier":"s:13MarvelService10OperationsO22getCharactersByStoryIdO5InputV5QueryV","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:13MarvelService10OperationsO22getCharactersByStoryIdO","text":"getCharactersByStoryId"},{"kind":"text","text":"."},{"kind":"typeIdentifier","preciseIdentifier":"s:13MarvelService10OperationsO22getCharactersByStoryIdO5InputV","text":"Input"},{"kind":"text","text":"."},{"kind":"typeIdentifier","preciseIdentifier":"s:13MarvelService10OperationsO22getCharactersByStoryIdO5InputV7HeadersV","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:13MarvelService10OperationsO22getCharactersByStoryIdO","text":"getCharactersByStoryId"},{"kind":"text","text":"."},{"kind":"typeIdentifier","preciseIdentifier":"s:13MarvelService10OperationsO22getCharactersByStoryIdO6OutputO","text":"Output"}],"extendedModule":"MarvelService","roleHeading":"Instance Method","modules":[{"name":"MarvelService"}],"externalID":"s:13MarvelService11APIProtocolPAAE22getCharactersByStoryId4path5query7headersAA10OperationsOADO6OutputOAJ5InputV4PathV_AN5QueryVAN7HeadersVtYaKF","symbolKind":"method"},"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/MarvelService\/documentation\/MarvelService\/APIProtocol\/getCharactersByStoryId(path:query:headers:)"},"primaryContentSections":[{"declarations":[{"tokens":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"getCharactersByStoryId"},{"kind":"text","text":"("},{"kind":"externalParam","text":"path"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Operations","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations","preciseIdentifier":"s:13MarvelService10OperationsO"},{"kind":"text","text":"."},{"kind":"typeIdentifier","text":"getCharactersByStoryId","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getCharactersByStoryId","preciseIdentifier":"s:13MarvelService10OperationsO22getCharactersByStoryIdO"},{"kind":"text","text":"."},{"kind":"typeIdentifier","text":"Input","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getCharactersByStoryId\/Input","preciseIdentifier":"s:13MarvelService10OperationsO22getCharactersByStoryIdO5InputV"},{"kind":"text","text":"."},{"kind":"typeIdentifier","text":"Path","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getCharactersByStoryId\/Input\/Path-swift.struct","preciseIdentifier":"s:13MarvelService10OperationsO22getCharactersByStoryIdO5InputV4PathV"},{"kind":"text","text":", "},{"kind":"externalParam","text":"query"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Operations","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations","preciseIdentifier":"s:13MarvelService10OperationsO"},{"kind":"text","text":"."},{"kind":"typeIdentifier","text":"getCharactersByStoryId","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getCharactersByStoryId","preciseIdentifier":"s:13MarvelService10OperationsO22getCharactersByStoryIdO"},{"kind":"text","text":"."},{"kind":"typeIdentifier","text":"Input","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getCharactersByStoryId\/Input","preciseIdentifier":"s:13MarvelService10OperationsO22getCharactersByStoryIdO5InputV"},{"kind":"text","text":"."},{"kind":"typeIdentifier","text":"Query","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getCharactersByStoryId\/Input\/Query-swift.struct","preciseIdentifier":"s:13MarvelService10OperationsO22getCharactersByStoryIdO5InputV5QueryV"},{"kind":"text","text":" = .init(), "},{"kind":"externalParam","text":"headers"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Operations","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations","preciseIdentifier":"s:13MarvelService10OperationsO"},{"kind":"text","text":"."},{"kind":"typeIdentifier","text":"getCharactersByStoryId","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getCharactersByStoryId","preciseIdentifier":"s:13MarvelService10OperationsO22getCharactersByStoryIdO"},{"kind":"text","text":"."},{"kind":"typeIdentifier","text":"Input","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getCharactersByStoryId\/Input","preciseIdentifier":"s:13MarvelService10OperationsO22getCharactersByStoryIdO5InputV"},{"kind":"text","text":"."},{"kind":"typeIdentifier","text":"Headers","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getCharactersByStoryId\/Input\/Headers-swift.struct","preciseIdentifier":"s:13MarvelService10OperationsO22getCharactersByStoryIdO5InputV7HeadersV"},{"kind":"text","text":" = .init()) "},{"kind":"keyword","text":"async"},{"kind":"text","text":" "},{"kind":"keyword","text":"throws"},{"kind":"text","text":" -> "},{"kind":"typeIdentifier","text":"Operations","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations","preciseIdentifier":"s:13MarvelService10OperationsO"},{"kind":"text","text":"."},{"kind":"typeIdentifier","text":"getCharactersByStoryId","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getCharactersByStoryId","preciseIdentifier":"s:13MarvelService10OperationsO22getCharactersByStoryIdO"},{"kind":"text","text":"."},{"kind":"typeIdentifier","text":"Output","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getCharactersByStoryId\/Output","preciseIdentifier":"s:13MarvelService10OperationsO22getCharactersByStoryIdO6OutputO"}],"platforms":["macOS"],"languages":["swift"]}],"kind":"declarations"},{"content":[{"level":2,"anchor":"discussion","type":"heading","text":"Discussion"},{"inlineContent":[{"type":"text","text":"Fetches lists of comic characters appearing in a single story, with optional filters."}],"type":"paragraph"},{"name":"Remark","content":[{"inlineContent":[{"type":"text","text":"HTTP "},{"type":"codeVoice","code":"GET \/v1\/public\/stories\/{storyId}\/characters"},{"type":"text","text":"."}],"type":"paragraph"}],"type":"aside","style":"note"},{"name":"Remark","content":[{"inlineContent":[{"type":"text","text":"Generated from "},{"type":"codeVoice","code":"#\/paths\/\/v1\/public\/stories\/{storyId}\/characters\/get(getCharactersByStoryId)"},{"type":"text","text":"."}],"type":"paragraph"}],"type":"aside","style":"note"}],"kind":"content"}],"schemaVersion":{"minor":3,"patch":0,"major":0},"variants":[{"paths":["\/documentation\/marvelservice\/apiprotocol\/getcharactersbystoryid(path:query:headers:)"],"traits":[{"interfaceLanguage":"swift"}]}],"abstract":[{"type":"text","text":"Fetches lists of characters filtered by a story id."}],"kind":"symbol","hierarchy":{"paths":[["doc:\/\/MarvelService\/documentation\/MarvelService","doc:\/\/MarvelService\/documentation\/MarvelService\/APIProtocol"]]},"sections":[],"references":{"doc://MarvelService/documentation/MarvelService/Operations/getCharactersByStoryId/Input/Path-swift.struct":{"kind":"symbol","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getCharactersByStoryId\/Input\/Path-swift.struct","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"Path"}],"navigatorTitle":[{"kind":"identifier","text":"Path"}],"role":"symbol","url":"\/documentation\/marvelservice\/operations\/getcharactersbystoryid\/input\/path-swift.struct","abstract":[],"type":"topic","title":"Operations.getCharactersByStoryId.Input.Path"},"doc://MarvelService/documentation/MarvelService/Operations":{"role":"symbol","abstract":[{"type":"text","text":"API operations, with input and output types, generated from "},{"type":"codeVoice","code":"#\/paths"},{"type":"text","text":" in the OpenAPI document."}],"kind":"symbol","fragments":[{"text":"enum","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"Operations"}],"navigatorTitle":[{"text":"Operations","kind":"identifier"}],"type":"topic","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations","title":"Operations","url":"\/documentation\/marvelservice\/operations"},"doc://MarvelService/documentation/MarvelService/Operations/getCharactersByStoryId/Input/Query-swift.struct":{"title":"Operations.getCharactersByStoryId.Input.Query","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getCharactersByStoryId\/Input\/Query-swift.struct","fragments":[{"kind":"keyword","text":"struct"},{"text":" ","kind":"text"},{"kind":"identifier","text":"Query"}],"navigatorTitle":[{"text":"Query","kind":"identifier"}],"role":"symbol","url":"\/documentation\/marvelservice\/operations\/getcharactersbystoryid\/input\/query-swift.struct","abstract":[],"kind":"symbol","type":"topic"},"doc://MarvelService/documentation/MarvelService/APIProtocol/getCharactersByStoryId(path:query:headers:)":{"identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/APIProtocol\/getCharactersByStoryId(path:query:headers:)","kind":"symbol","abstract":[{"type":"text","text":"Fetches lists of characters filtered by a story id."}],"type":"topic","title":"getCharactersByStoryId(path:query:headers:)","url":"\/documentation\/marvelservice\/apiprotocol\/getcharactersbystoryid(path:query:headers:)","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"getCharactersByStoryId","kind":"identifier"},{"text":"(","kind":"text"},{"text":"path","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"Operations","kind":"typeIdentifier","preciseIdentifier":"s:13MarvelService10OperationsO"},{"text":".","kind":"text"},{"text":"getCharactersByStoryId","kind":"typeIdentifier","preciseIdentifier":"s:13MarvelService10OperationsO22getCharactersByStoryIdO"},{"text":".","kind":"text"},{"text":"Input","kind":"typeIdentifier","preciseIdentifier":"s:13MarvelService10OperationsO22getCharactersByStoryIdO5InputV"},{"text":".","kind":"text"},{"text":"Path","kind":"typeIdentifier","preciseIdentifier":"s:13MarvelService10OperationsO22getCharactersByStoryIdO5InputV4PathV"},{"text":", ","kind":"text"},{"text":"query","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"Operations","kind":"typeIdentifier","preciseIdentifier":"s:13MarvelService10OperationsO"},{"text":".","kind":"text"},{"text":"getCharactersByStoryId","kind":"typeIdentifier","preciseIdentifier":"s:13MarvelService10OperationsO22getCharactersByStoryIdO"},{"text":".","kind":"text"},{"text":"Input","kind":"typeIdentifier","preciseIdentifier":"s:13MarvelService10OperationsO22getCharactersByStoryIdO5InputV"},{"text":".","kind":"text"},{"text":"Query","kind":"typeIdentifier","preciseIdentifier":"s:13MarvelService10OperationsO22getCharactersByStoryIdO5InputV5QueryV"},{"text":", ","kind":"text"},{"text":"headers","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"Operations","kind":"typeIdentifier","preciseIdentifier":"s:13MarvelService10OperationsO"},{"text":".","kind":"text"},{"text":"getCharactersByStoryId","kind":"typeIdentifier","preciseIdentifier":"s:13MarvelService10OperationsO22getCharactersByStoryIdO"},{"text":".","kind":"text"},{"text":"Input","kind":"typeIdentifier","preciseIdentifier":"s:13MarvelService10OperationsO22getCharactersByStoryIdO5InputV"},{"text":".","kind":"text"},{"text":"Headers","kind":"typeIdentifier","preciseIdentifier":"s:13MarvelService10OperationsO22getCharactersByStoryIdO5InputV7HeadersV"},{"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":"getCharactersByStoryId","kind":"typeIdentifier","preciseIdentifier":"s:13MarvelService10OperationsO22getCharactersByStoryIdO"},{"text":".","kind":"text"},{"text":"Output","kind":"typeIdentifier","preciseIdentifier":"s:13MarvelService10OperationsO22getCharactersByStoryIdO6OutputO"}],"role":"symbol"},"doc://MarvelService/documentation/MarvelService/APIProtocol":{"url":"\/documentation\/marvelservice\/apiprotocol","role":"symbol","navigatorTitle":[{"kind":"identifier","text":"APIProtocol"}],"type":"topic","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/APIProtocol","title":"APIProtocol","fragments":[{"kind":"keyword","text":"protocol"},{"kind":"text","text":" "},{"kind":"identifier","text":"APIProtocol"}],"abstract":[{"type":"text","text":"A type that performs HTTP operations defined by the OpenAPI document."}],"kind":"symbol"},"doc://MarvelService/documentation/MarvelService/Operations/getCharactersByStoryId":{"identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getCharactersByStoryId","kind":"symbol","abstract":[{"type":"text","text":"Fetches lists of characters filtered by a story id."}],"type":"topic","title":"Operations.getCharactersByStoryId","navigatorTitle":[{"kind":"identifier","text":"getCharactersByStoryId"}],"url":"\/documentation\/marvelservice\/operations\/getcharactersbystoryid","fragments":[{"kind":"keyword","text":"enum"},{"kind":"text","text":" "},{"kind":"identifier","text":"getCharactersByStoryId"}],"role":"symbol"},"doc://MarvelService/documentation/MarvelService/Operations/getCharactersByStoryId/Input":{"url":"\/documentation\/marvelservice\/operations\/getcharactersbystoryid\/input","role":"symbol","navigatorTitle":[{"kind":"identifier","text":"Input"}],"type":"topic","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getCharactersByStoryId\/Input","title":"Operations.getCharactersByStoryId.Input","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"Input"}],"abstract":[],"kind":"symbol"},"doc://MarvelService/documentation/MarvelService/Operations/getCharactersByStoryId/Output":{"identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getCharactersByStoryId\/Output","kind":"symbol","abstract":[],"type":"topic","title":"Operations.getCharactersByStoryId.Output","navigatorTitle":[{"kind":"identifier","text":"Output"}],"url":"\/documentation\/marvelservice\/operations\/getcharactersbystoryid\/output","fragments":[{"kind":"keyword","text":"enum"},{"kind":"text","text":" "},{"kind":"identifier","text":"Output"}],"role":"symbol"},"doc://MarvelService/documentation/MarvelService/Operations/getCharactersByStoryId/Input/Headers-swift.struct":{"identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getCharactersByStoryId\/Input\/Headers-swift.struct","kind":"symbol","abstract":[],"type":"topic","title":"Operations.getCharactersByStoryId.Input.Headers","navigatorTitle":[{"text":"Headers","kind":"identifier"}],"url":"\/documentation\/marvelservice\/operations\/getcharactersbystoryid\/input\/headers-swift.struct","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Headers","kind":"identifier"}],"role":"symbol"},"doc://MarvelService/documentation/MarvelService":{"kind":"symbol","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService","role":"collection","abstract":[{"type":"text","text":"A library that allows the developer to interact with the "},{"type":"strong","inlineContent":[{"type":"text","text":"Marvel Comics API"}]},{"type":"text","text":" backend service."}],"url":"\/documentation\/marvelservice","type":"topic","title":"MarvelService"}}}