Files
marvel-service/docs/data/documentation/marvelservice/client/getstoriesbyeventid(_:).json
T

1 line
9.3 KiB
JSON

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