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
9.4 KiB
JSON
1 line
9.4 KiB
JSON
{"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/MarvelService\/documentation\/MarvelService\/APIProtocol\/getEventsByComicId(_:)"},"abstract":[{"text":"Fetches lists of events filtered by a comic id.","type":"text"}],"schemaVersion":{"major":0,"patch":0,"minor":3},"sections":[],"hierarchy":{"paths":[["doc:\/\/MarvelService\/documentation\/MarvelService","doc:\/\/MarvelService\/documentation\/MarvelService\/APIProtocol"]]},"primaryContentSections":[{"declarations":[{"languages":["swift"],"platforms":["macOS"],"tokens":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"getEventsByComicId","kind":"identifier"},{"text":"(","kind":"text"},{"text":"_","kind":"externalParam"},{"text":" ","kind":"text"},{"text":"input","kind":"internalParam"},{"text":": ","kind":"text"},{"identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations","text":"Operations","kind":"typeIdentifier","preciseIdentifier":"s:13MarvelService10OperationsO"},{"text":".","kind":"text"},{"identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getEventsByComicId","text":"getEventsByComicId","kind":"typeIdentifier","preciseIdentifier":"s:13MarvelService10OperationsO18getEventsByComicIdO"},{"text":".","kind":"text"},{"identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getEventsByComicId\/Input","text":"Input","kind":"typeIdentifier","preciseIdentifier":"s:13MarvelService10OperationsO18getEventsByComicIdO5InputV"},{"text":") ","kind":"text"},{"text":"async","kind":"keyword"},{"text":" ","kind":"text"},{"text":"throws","kind":"keyword"},{"text":" -> ","kind":"text"},{"identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations","text":"Operations","kind":"typeIdentifier","preciseIdentifier":"s:13MarvelService10OperationsO"},{"text":".","kind":"text"},{"identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getEventsByComicId","text":"getEventsByComicId","kind":"typeIdentifier","preciseIdentifier":"s:13MarvelService10OperationsO18getEventsByComicIdO"},{"text":".","kind":"text"},{"identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getEventsByComicId\/Output","text":"Output","kind":"typeIdentifier","preciseIdentifier":"s:13MarvelService10OperationsO18getEventsByComicIdO6OutputO"}]}],"kind":"declarations"},{"kind":"content","content":[{"text":"Discussion","type":"heading","level":2,"anchor":"discussion"},{"inlineContent":[{"type":"text","text":"Fetches lists of events in which a specific comic appears, with optional filters."}],"type":"paragraph"},{"type":"aside","name":"Remark","content":[{"type":"paragraph","inlineContent":[{"text":"HTTP ","type":"text"},{"type":"codeVoice","code":"GET \/v1\/public\/comics\/{comicId}\/events"},{"text":".","type":"text"}]}],"style":"note"},{"type":"aside","name":"Remark","content":[{"type":"paragraph","inlineContent":[{"text":"Generated from ","type":"text"},{"type":"codeVoice","code":"#\/paths\/\/v1\/public\/comics\/{comicId}\/events\/get(getEventsByComicId)"},{"text":".","type":"text"}]}],"style":"note"}]}],"kind":"symbol","variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/marvelservice\/apiprotocol\/geteventsbycomicid(_:)"]}],"metadata":{"required":true,"externalID":"s:13MarvelService11APIProtocolP18getEventsByComicIdyAA10OperationsOADO6OutputOAG5InputVYaKF","title":"getEventsByComicId(_:)","symbolKind":"method","roleHeading":"Instance Method","modules":[{"name":"MarvelService"}],"fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"getEventsByComicId","kind":"identifier"},{"text":"(","kind":"text"},{"text":"Operations","kind":"typeIdentifier","preciseIdentifier":"s:13MarvelService10OperationsO"},{"text":".","kind":"text"},{"text":"getEventsByComicId","kind":"typeIdentifier","preciseIdentifier":"s:13MarvelService10OperationsO18getEventsByComicIdO"},{"text":".","kind":"text"},{"text":"Input","kind":"typeIdentifier","preciseIdentifier":"s:13MarvelService10OperationsO18getEventsByComicIdO5InputV"},{"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":"getEventsByComicId","kind":"typeIdentifier","preciseIdentifier":"s:13MarvelService10OperationsO18getEventsByComicIdO"},{"text":".","kind":"text"},{"text":"Output","kind":"typeIdentifier","preciseIdentifier":"s:13MarvelService10OperationsO18getEventsByComicIdO6OutputO"}],"role":"symbol"},"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/Operations/getEventsByComicId/Output":{"identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getEventsByComicId\/Output","kind":"symbol","abstract":[],"type":"topic","title":"Operations.getEventsByComicId.Output","navigatorTitle":[{"text":"Output","kind":"identifier"}],"url":"\/documentation\/marvelservice\/operations\/geteventsbycomicid\/output","fragments":[{"text":"enum","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Output","kind":"identifier"}],"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/getEventsByComicId/Input":{"url":"\/documentation\/marvelservice\/operations\/geteventsbycomicid\/input","role":"symbol","navigatorTitle":[{"kind":"identifier","text":"Input"}],"type":"topic","title":"Operations.getEventsByComicId.Input","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getEventsByComicId\/Input","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"Input"}],"abstract":[],"kind":"symbol"},"doc://MarvelService/documentation/MarvelService/APIProtocol/getEventsByComicId(_:)":{"identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/APIProtocol\/getEventsByComicId(_:)","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"getEventsByComicId","kind":"identifier"},{"text":"(","kind":"text"},{"text":"Operations","preciseIdentifier":"s:13MarvelService10OperationsO","kind":"typeIdentifier"},{"text":".","kind":"text"},{"text":"getEventsByComicId","preciseIdentifier":"s:13MarvelService10OperationsO18getEventsByComicIdO","kind":"typeIdentifier"},{"text":".","kind":"text"},{"text":"Input","preciseIdentifier":"s:13MarvelService10OperationsO18getEventsByComicIdO5InputV","kind":"typeIdentifier"},{"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":"getEventsByComicId","kind":"typeIdentifier","preciseIdentifier":"s:13MarvelService10OperationsO18getEventsByComicIdO"},{"text":".","kind":"text"},{"text":"Output","kind":"typeIdentifier","preciseIdentifier":"s:13MarvelService10OperationsO18getEventsByComicIdO6OutputO"}],"kind":"symbol","abstract":[{"type":"text","text":"Fetches lists of events filtered by a comic id."}],"type":"topic","title":"getEventsByComicId(_:)","url":"\/documentation\/marvelservice\/apiprotocol\/geteventsbycomicid(_:)","required":true,"role":"symbol"},"doc://MarvelService/documentation/MarvelService/Operations/getEventsByComicId":{"identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getEventsByComicId","kind":"symbol","abstract":[{"type":"text","text":"Fetches lists of events filtered by a comic id."}],"type":"topic","title":"Operations.getEventsByComicId","navigatorTitle":[{"text":"getEventsByComicId","kind":"identifier"}],"url":"\/documentation\/marvelservice\/operations\/geteventsbycomicid","fragments":[{"text":"enum","kind":"keyword"},{"text":" ","kind":"text"},{"text":"getEventsByComicId","kind":"identifier"}],"role":"symbol"},"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"}}} |