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

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