a83da81414
This PR contains the work done to fix some bug fixes that were encountered while quickly testing the interactions with the service endpoints. Furthermore, there is also a possible fix to build this library for non-apple platforms. Reviewed-on: #8 Co-authored-by: Javier Cicchelli <javier@rock-n-code.com> Co-committed-by: Javier Cicchelli <javier@rock-n-code.com>
1 line
17 KiB
JSON
1 line
17 KiB
JSON
{"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/MarvelService\/documentation\/MarvelService\/APIProtocol\/getEventsBySeriesId(path:query:headers:)"},"abstract":[{"text":"Fetches lists of events filtered by a series id.","type":"text"}],"schemaVersion":{"patch":0,"minor":3,"major":0},"sections":[],"hierarchy":{"paths":[["doc:\/\/MarvelService\/documentation\/MarvelService","doc:\/\/MarvelService\/documentation\/MarvelService\/APIProtocol"]]},"primaryContentSections":[{"declarations":[{"languages":["swift"],"tokens":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"getEventsBySeriesId"},{"kind":"text","text":"("},{"kind":"externalParam","text":"path"},{"kind":"text","text":": "},{"identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations","kind":"typeIdentifier","text":"Operations","preciseIdentifier":"s:13MarvelService10OperationsO"},{"kind":"text","text":"."},{"kind":"typeIdentifier","preciseIdentifier":"s:13MarvelService10OperationsO19getEventsBySeriesIdO","text":"getEventsBySeriesId","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getEventsBySeriesId"},{"kind":"text","text":"."},{"kind":"typeIdentifier","preciseIdentifier":"s:13MarvelService10OperationsO19getEventsBySeriesIdO5InputV","text":"Input","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getEventsBySeriesId\/Input"},{"kind":"text","text":"."},{"kind":"typeIdentifier","preciseIdentifier":"s:13MarvelService10OperationsO19getEventsBySeriesIdO5InputV4PathV","text":"Path","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getEventsBySeriesId\/Input\/Path-swift.struct"},{"kind":"text","text":", "},{"kind":"externalParam","text":"query"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:13MarvelService10OperationsO","text":"Operations","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations"},{"kind":"text","text":"."},{"kind":"typeIdentifier","preciseIdentifier":"s:13MarvelService10OperationsO19getEventsBySeriesIdO","text":"getEventsBySeriesId","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getEventsBySeriesId"},{"kind":"text","text":"."},{"kind":"typeIdentifier","preciseIdentifier":"s:13MarvelService10OperationsO19getEventsBySeriesIdO5InputV","text":"Input","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getEventsBySeriesId\/Input"},{"kind":"text","text":"."},{"kind":"typeIdentifier","preciseIdentifier":"s:13MarvelService10OperationsO19getEventsBySeriesIdO5InputV5QueryV","text":"Query","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getEventsBySeriesId\/Input\/Query-swift.struct"},{"kind":"text","text":" = .init(), "},{"kind":"externalParam","text":"headers"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:13MarvelService10OperationsO","text":"Operations","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations"},{"kind":"text","text":"."},{"kind":"typeIdentifier","text":"getEventsBySeriesId","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getEventsBySeriesId","preciseIdentifier":"s:13MarvelService10OperationsO19getEventsBySeriesIdO"},{"kind":"text","text":"."},{"identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getEventsBySeriesId\/Input","kind":"typeIdentifier","text":"Input","preciseIdentifier":"s:13MarvelService10OperationsO19getEventsBySeriesIdO5InputV"},{"kind":"text","text":"."},{"identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getEventsBySeriesId\/Input\/Headers-swift.struct","kind":"typeIdentifier","text":"Headers","preciseIdentifier":"s:13MarvelService10OperationsO19getEventsBySeriesIdO5InputV7HeadersV"},{"kind":"text","text":" = .init()) "},{"kind":"keyword","text":"async"},{"kind":"text","text":" "},{"kind":"keyword","text":"throws"},{"kind":"text","text":" -> "},{"kind":"typeIdentifier","preciseIdentifier":"s:13MarvelService10OperationsO","text":"Operations","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations"},{"kind":"text","text":"."},{"kind":"typeIdentifier","preciseIdentifier":"s:13MarvelService10OperationsO19getEventsBySeriesIdO","text":"getEventsBySeriesId","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getEventsBySeriesId"},{"kind":"text","text":"."},{"kind":"typeIdentifier","preciseIdentifier":"s:13MarvelService10OperationsO19getEventsBySeriesIdO6OutputO","text":"Output","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getEventsBySeriesId\/Output"}],"platforms":["macOS"]}],"kind":"declarations"},{"content":[{"type":"heading","text":"Discussion","level":2,"anchor":"discussion"},{"inlineContent":[{"type":"text","text":"Fetches lists of events which occur in a specific series, with optional filters."}],"type":"paragraph"},{"style":"note","name":"Remark","type":"aside","content":[{"inlineContent":[{"type":"text","text":"HTTP "},{"code":"GET \/v1\/public\/series\/{seriesId}\/events","type":"codeVoice"},{"type":"text","text":"."}],"type":"paragraph"}]},{"name":"Remark","content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"Generated from "},{"type":"codeVoice","code":"#\/paths\/\/v1\/public\/series\/{seriesId}\/events\/get(getEventsBySeriesId)"},{"type":"text","text":"."}]}],"type":"aside","style":"note"}],"kind":"content"}],"kind":"symbol","variants":[{"paths":["\/documentation\/marvelservice\/apiprotocol\/geteventsbyseriesid(path:query:headers:)"],"traits":[{"interfaceLanguage":"swift"}]}],"metadata":{"extendedModule":"MarvelService","externalID":"s:13MarvelService11APIProtocolPAAE19getEventsBySeriesId4path5query7headersAA10OperationsOADO6OutputOAJ5InputV4PathV_AN5QueryVAN7HeadersVtYaKF","title":"getEventsBySeriesId(path:query:headers:)","symbolKind":"method","roleHeading":"Instance Method","modules":[{"name":"MarvelService"}],"fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"getEventsBySeriesId"},{"kind":"text","text":"("},{"kind":"externalParam","text":"path"},{"kind":"text","text":": "},{"preciseIdentifier":"s:13MarvelService10OperationsO","kind":"typeIdentifier","text":"Operations"},{"kind":"text","text":"."},{"preciseIdentifier":"s:13MarvelService10OperationsO19getEventsBySeriesIdO","kind":"typeIdentifier","text":"getEventsBySeriesId"},{"kind":"text","text":"."},{"preciseIdentifier":"s:13MarvelService10OperationsO19getEventsBySeriesIdO5InputV","kind":"typeIdentifier","text":"Input"},{"kind":"text","text":"."},{"preciseIdentifier":"s:13MarvelService10OperationsO19getEventsBySeriesIdO5InputV4PathV","kind":"typeIdentifier","text":"Path"},{"kind":"text","text":", "},{"kind":"externalParam","text":"query"},{"kind":"text","text":": "},{"preciseIdentifier":"s:13MarvelService10OperationsO","kind":"typeIdentifier","text":"Operations"},{"kind":"text","text":"."},{"preciseIdentifier":"s:13MarvelService10OperationsO19getEventsBySeriesIdO","kind":"typeIdentifier","text":"getEventsBySeriesId"},{"kind":"text","text":"."},{"preciseIdentifier":"s:13MarvelService10OperationsO19getEventsBySeriesIdO5InputV","kind":"typeIdentifier","text":"Input"},{"kind":"text","text":"."},{"preciseIdentifier":"s:13MarvelService10OperationsO19getEventsBySeriesIdO5InputV5QueryV","kind":"typeIdentifier","text":"Query"},{"kind":"text","text":", "},{"kind":"externalParam","text":"headers"},{"kind":"text","text":": "},{"preciseIdentifier":"s:13MarvelService10OperationsO","kind":"typeIdentifier","text":"Operations"},{"kind":"text","text":"."},{"preciseIdentifier":"s:13MarvelService10OperationsO19getEventsBySeriesIdO","kind":"typeIdentifier","text":"getEventsBySeriesId"},{"kind":"text","text":"."},{"preciseIdentifier":"s:13MarvelService10OperationsO19getEventsBySeriesIdO5InputV","kind":"typeIdentifier","text":"Input"},{"kind":"text","text":"."},{"preciseIdentifier":"s:13MarvelService10OperationsO19getEventsBySeriesIdO5InputV7HeadersV","kind":"typeIdentifier","text":"Headers"},{"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:13MarvelService10OperationsO19getEventsBySeriesIdO","kind":"typeIdentifier","text":"getEventsBySeriesId"},{"kind":"text","text":"."},{"preciseIdentifier":"s:13MarvelService10OperationsO19getEventsBySeriesIdO6OutputO","kind":"typeIdentifier","text":"Output"}],"role":"symbol"},"references":{"doc://MarvelService/documentation/MarvelService/Operations/getEventsBySeriesId/Output":{"fragments":[{"text":"enum","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Output","kind":"identifier"}],"role":"symbol","url":"\/documentation\/marvelservice\/operations\/geteventsbyseriesid\/output","kind":"symbol","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getEventsBySeriesId\/Output","title":"Operations.getEventsBySeriesId.Output","abstract":[],"type":"topic","navigatorTitle":[{"text":"Output","kind":"identifier"}]},"doc://MarvelService/documentation/MarvelService/Operations/getEventsBySeriesId/Input/Query-swift.struct":{"identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getEventsBySeriesId\/Input\/Query-swift.struct","kind":"symbol","abstract":[],"type":"topic","title":"Operations.getEventsBySeriesId.Input.Query","navigatorTitle":[{"kind":"identifier","text":"Query"}],"url":"\/documentation\/marvelservice\/operations\/geteventsbyseriesid\/input\/query-swift.struct","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"Query"}],"role":"symbol"},"doc://MarvelService/documentation/MarvelService/APIProtocol/getEventsBySeriesId(path:query:headers:)":{"identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/APIProtocol\/getEventsBySeriesId(path:query:headers:)","kind":"symbol","abstract":[{"type":"text","text":"Fetches lists of events filtered by a series id."}],"type":"topic","title":"getEventsBySeriesId(path:query:headers:)","url":"\/documentation\/marvelservice\/apiprotocol\/geteventsbyseriesid(path:query:headers:)","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"getEventsBySeriesId","kind":"identifier"},{"text":"(","kind":"text"},{"text":"path","kind":"externalParam"},{"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":"Path","kind":"typeIdentifier","preciseIdentifier":"s:13MarvelService10OperationsO19getEventsBySeriesIdO5InputV4PathV"},{"text":", ","kind":"text"},{"text":"query","kind":"externalParam"},{"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":"Query","kind":"typeIdentifier","preciseIdentifier":"s:13MarvelService10OperationsO19getEventsBySeriesIdO5InputV5QueryV"},{"text":", ","kind":"text"},{"text":"headers","kind":"externalParam"},{"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":"Headers","kind":"typeIdentifier","preciseIdentifier":"s:13MarvelService10OperationsO19getEventsBySeriesIdO5InputV7HeadersV"},{"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"}],"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/getEventsBySeriesId":{"identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getEventsBySeriesId","kind":"symbol","abstract":[{"type":"text","text":"Fetches lists of events filtered by a series id."}],"type":"topic","title":"Operations.getEventsBySeriesId","navigatorTitle":[{"kind":"identifier","text":"getEventsBySeriesId"}],"url":"\/documentation\/marvelservice\/operations\/geteventsbyseriesid","fragments":[{"kind":"keyword","text":"enum"},{"kind":"text","text":" "},{"kind":"identifier","text":"getEventsBySeriesId"}],"role":"symbol"},"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/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/getEventsBySeriesId/Input/Path-swift.struct":{"identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getEventsBySeriesId\/Input\/Path-swift.struct","kind":"symbol","abstract":[],"type":"topic","title":"Operations.getEventsBySeriesId.Input.Path","navigatorTitle":[{"kind":"identifier","text":"Path"}],"url":"\/documentation\/marvelservice\/operations\/geteventsbyseriesid\/input\/path-swift.struct","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"Path"}],"role":"symbol"},"doc://MarvelService/documentation/MarvelService/Operations/getEventsBySeriesId/Input/Headers-swift.struct":{"url":"\/documentation\/marvelservice\/operations\/geteventsbyseriesid\/input\/headers-swift.struct","role":"symbol","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getEventsBySeriesId\/Input\/Headers-swift.struct","abstract":[],"navigatorTitle":[{"text":"Headers","kind":"identifier"}],"fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Headers","kind":"identifier"}],"kind":"symbol","type":"topic","title":"Operations.getEventsBySeriesId.Input.Headers"},"doc://MarvelService/documentation/MarvelService/Operations/getEventsBySeriesId/Input":{"identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getEventsBySeriesId\/Input","kind":"symbol","abstract":[],"type":"topic","title":"Operations.getEventsBySeriesId.Input","navigatorTitle":[{"kind":"identifier","text":"Input"}],"url":"\/documentation\/marvelservice\/operations\/geteventsbyseriesid\/input","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"Input"}],"role":"symbol"}}} |