Files
marvel-service/docs/data/documentation/marvelservice/apiprotocol/geteventsbyseriesid(_:).json
T
javier fc84db4881 Updated license to Apache v2.0 (#9)
This PR contains the work done to update the license to *Apache v2.0* and also, to update any file header and/or mention as necessary.

Reviewed-on: #9
Co-authored-by: Javier Cicchelli <javier@rock-n-code.com>
Co-committed-by: Javier Cicchelli <javier@rock-n-code.com>
2025-10-07 23:02:12 +00:00

1 line
9.4 KiB
JSON

{"schemaVersion":{"major":0,"minor":3,"patch":0},"metadata":{"role":"symbol","symbolKind":"method","modules":[{"name":"MarvelService"}],"title":"getEventsBySeriesId(_:)","externalID":"s:13MarvelService11APIProtocolP19getEventsBySeriesIdyAA10OperationsOADO6OutputOAG5InputVYaKF","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"getEventsBySeriesId"},{"kind":"text","text":"("},{"kind":"typeIdentifier","text":"Operations","preciseIdentifier":"s:13MarvelService10OperationsO"},{"kind":"text","text":"."},{"kind":"typeIdentifier","text":"getEventsBySeriesId","preciseIdentifier":"s:13MarvelService10OperationsO19getEventsBySeriesIdO"},{"kind":"text","text":"."},{"kind":"typeIdentifier","text":"Input","preciseIdentifier":"s:13MarvelService10OperationsO19getEventsBySeriesIdO5InputV"},{"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":"getEventsBySeriesId","preciseIdentifier":"s:13MarvelService10OperationsO19getEventsBySeriesIdO"},{"kind":"text","text":"."},{"kind":"typeIdentifier","text":"Output","preciseIdentifier":"s:13MarvelService10OperationsO19getEventsBySeriesIdO6OutputO"}],"required":true,"roleHeading":"Instance Method"},"kind":"symbol","abstract":[{"type":"text","text":"Fetches lists of events filtered by a series id."}],"primaryContentSections":[{"kind":"declarations","declarations":[{"platforms":["macOS"],"languages":["swift"],"tokens":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"getEventsBySeriesId"},{"kind":"text","text":"("},{"kind":"externalParam","text":"_"},{"kind":"text","text":" "},{"kind":"internalParam","text":"input"},{"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\/getEventsBySeriesId","preciseIdentifier":"s:13MarvelService10OperationsO19getEventsBySeriesIdO","text":"getEventsBySeriesId"},{"kind":"text","text":"."},{"kind":"typeIdentifier","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getEventsBySeriesId\/Input","preciseIdentifier":"s:13MarvelService10OperationsO19getEventsBySeriesIdO5InputV","text":"Input"},{"kind":"text","text":") "},{"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\/getEventsBySeriesId","preciseIdentifier":"s:13MarvelService10OperationsO19getEventsBySeriesIdO","text":"getEventsBySeriesId"},{"kind":"text","text":"."},{"kind":"typeIdentifier","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getEventsBySeriesId\/Output","preciseIdentifier":"s:13MarvelService10OperationsO19getEventsBySeriesIdO6OutputO","text":"Output"}]}]},{"content":[{"text":"Discussion","anchor":"discussion","level":2,"type":"heading"},{"inlineContent":[{"text":"Fetches lists of events which occur in 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}\/events","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}\/events\/get(getEventsBySeriesId)","type":"codeVoice"},{"text":".","type":"text"}]}]}],"kind":"content"}],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/MarvelService\/documentation\/MarvelService\/APIProtocol\/getEventsBySeriesId(_:)"},"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/marvelservice\/apiprotocol\/geteventsbyseriesid(_:)"]}],"sections":[],"hierarchy":{"paths":[["doc:\/\/MarvelService\/documentation\/MarvelService","doc:\/\/MarvelService\/documentation\/MarvelService\/APIProtocol"]]},"references":{"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/getEventsBySeriesId/Output":{"identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getEventsBySeriesId\/Output","type":"topic","fragments":[{"kind":"keyword","text":"enum"},{"kind":"text","text":" "},{"kind":"identifier","text":"Output"}],"url":"\/documentation\/marvelservice\/operations\/geteventsbyseriesid\/output","title":"Operations.getEventsBySeriesId.Output","kind":"symbol","role":"symbol","navigatorTitle":[{"kind":"identifier","text":"Output"}],"abstract":[]},"doc://MarvelService/documentation/MarvelService/Operations/getEventsBySeriesId/Input":{"type":"topic","fragments":[{"text":"struct","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"Input"}],"abstract":[],"navigatorTitle":[{"kind":"identifier","text":"Input"}],"kind":"symbol","role":"symbol","title":"Operations.getEventsBySeriesId.Input","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getEventsBySeriesId\/Input","url":"\/documentation\/marvelservice\/operations\/geteventsbyseriesid\/input"},"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/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/Operations/getEventsBySeriesId":{"type":"topic","fragments":[{"kind":"keyword","text":"enum"},{"text":" ","kind":"text"},{"kind":"identifier","text":"getEventsBySeriesId"}],"abstract":[{"type":"text","text":"Fetches lists of events filtered by a series id."}],"navigatorTitle":[{"kind":"identifier","text":"getEventsBySeriesId"}],"kind":"symbol","role":"symbol","title":"Operations.getEventsBySeriesId","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getEventsBySeriesId","url":"\/documentation\/marvelservice\/operations\/geteventsbyseriesid"},"doc://MarvelService/documentation/MarvelService/APIProtocol/getEventsBySeriesId(_:)":{"role":"symbol","title":"getEventsBySeriesId(_:)","kind":"symbol","abstract":[{"type":"text","text":"Fetches lists of events filtered by a series id."}],"fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"getEventsBySeriesId","kind":"identifier"},{"text":"(","kind":"text"},{"text":"Operations","kind":"typeIdentifier","preciseIdentifier":"s:13MarvelService10OperationsO"},{"text":".","kind":"text"},{"text":"getEventsBySeriesId","kind":"typeIdentifier","preciseIdentifier":"s:13MarvelService10OperationsO19getEventsBySeriesIdO"},{"text":".","kind":"text"},{"text":"Input","kind":"typeIdentifier","preciseIdentifier":"s:13MarvelService10OperationsO19getEventsBySeriesIdO5InputV"},{"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":"getEventsBySeriesId","kind":"typeIdentifier","preciseIdentifier":"s:13MarvelService10OperationsO19getEventsBySeriesIdO"},{"text":".","kind":"text"},{"text":"Output","kind":"typeIdentifier","preciseIdentifier":"s:13MarvelService10OperationsO19getEventsBySeriesIdO6OutputO"}],"required":true,"url":"\/documentation\/marvelservice\/apiprotocol\/geteventsbyseriesid(_:)","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/APIProtocol\/getEventsBySeriesId(_:)","type":"topic"}}}