marvel-service/docs/data/documentation/marvelservice/client/getcharactersbystoryid(_:).json

{"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/MarvelService\/documentation\/MarvelService\/Client\/getCharactersByStoryId(_:)"},"metadata":{"roleHeading":"Instance Method","modules":[{"name":"MarvelService"}],"title":"getCharactersByStoryId(_:)","externalID":"s:13MarvelService6ClientV22getCharactersByStoryIdyAA10OperationsOADO6OutputOAG5InputVYaKF","symbolKind":"method","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"getCharactersByStoryId"},{"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":"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"}],"role":"symbol"},"kind":"symbol","variants":[{"paths":["\/documentation\/marvelservice\/client\/getcharactersbystoryid(_:)"],"traits":[{"interfaceLanguage":"swift"}]}],"primaryContentSections":[{"declarations":[{"tokens":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"getCharactersByStoryId"},{"kind":"text","text":"("},{"kind":"externalParam","text":"_"},{"kind":"text","text":" "},{"kind":"internalParam","text":"input"},{"kind":"text","text":": "},{"preciseIdentifier":"s:13MarvelService10OperationsO","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations","kind":"typeIdentifier","text":"Operations"},{"kind":"text","text":"."},{"preciseIdentifier":"s:13MarvelService10OperationsO22getCharactersByStoryIdO","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getCharactersByStoryId","kind":"typeIdentifier","text":"getCharactersByStoryId"},{"kind":"text","text":"."},{"preciseIdentifier":"s:13MarvelService10OperationsO22getCharactersByStoryIdO5InputV","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getCharactersByStoryId\/Input","kind":"typeIdentifier","text":"Input"},{"kind":"text","text":") "},{"kind":"keyword","text":"async"},{"kind":"text","text":" "},{"kind":"keyword","text":"throws"},{"kind":"text","text":" -> "},{"preciseIdentifier":"s:13MarvelService10OperationsO","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations","kind":"typeIdentifier","text":"Operations"},{"kind":"text","text":"."},{"preciseIdentifier":"s:13MarvelService10OperationsO22getCharactersByStoryIdO","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getCharactersByStoryId","kind":"typeIdentifier","text":"getCharactersByStoryId"},{"kind":"text","text":"."},{"preciseIdentifier":"s:13MarvelService10OperationsO22getCharactersByStoryIdO6OutputO","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getCharactersByStoryId\/Output","kind":"typeIdentifier","text":"Output"}],"platforms":["macOS"],"languages":["swift"]}],"kind":"declarations"},{"kind":"content","content":[{"type":"heading","level":2,"anchor":"discussion","text":"Discussion"},{"type":"paragraph","inlineContent":[{"type":"text","text":"Fetches lists of comic characters appearing in a single story, with optional filters."}]},{"type":"aside","name":"Remark","content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"HTTP "},{"code":"GET \/v1\/public\/stories\/{storyId}\/characters","type":"codeVoice"},{"type":"text","text":"."}]}],"style":"note"},{"type":"aside","name":"Remark","content":[{"inlineContent":[{"type":"text","text":"Generated from "},{"type":"codeVoice","code":"#\/paths\/\/v1\/public\/stories\/{storyId}\/characters\/get(getCharactersByStoryId)"},{"text":".","type":"text"}],"type":"paragraph"}],"style":"note"}]}],"schemaVersion":{"patch":0,"minor":3,"major":0},"abstract":[{"text":"Fetches lists of characters filtered by a story id.","type":"text"}],"sections":[],"hierarchy":{"paths":[["doc:\/\/MarvelService\/documentation\/MarvelService","doc:\/\/MarvelService\/documentation\/MarvelService\/Client"]]},"references":{"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/Client":{"identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Client","kind":"symbol","abstract":[{"type":"text","text":"The Marvel Comics RESTful API."}],"type":"topic","title":"Client","navigatorTitle":[{"kind":"identifier","text":"Client"}],"url":"\/documentation\/marvelservice\/client","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"Client"}],"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/Client/getCharactersByStoryId(_:)":{"url":"\/documentation\/marvelservice\/client\/getcharactersbystoryid(_:)","role":"symbol","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Client\/getCharactersByStoryId(_:)","abstract":[{"type":"text","text":"Fetches lists of characters filtered by a story id."}],"fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"getCharactersByStoryId"},{"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":"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"}],"kind":"symbol","type":"topic","title":"getCharactersByStoryId(_:)"},"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"},"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/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"}}}