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
{"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/marvelservice\/client\/getseriesbyeventid(path:query:headers:)"]}],"kind":"symbol","abstract":[{"text":"Fetches lists of series filtered by an event id.","type":"text"}],"metadata":{"role":"symbol","extendedModule":"MarvelService","externalID":"s:13MarvelService11APIProtocolPAAE18getSeriesByEventId4path5query7headersAA10OperationsOADO6OutputOAJ5InputV4PathV_AN5QueryVAN7HeadersVtYaKF::SYNTHESIZED::s:13MarvelService6ClientV","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"getSeriesByEventId","kind":"identifier"},{"text":"(","kind":"text"},{"text":"path","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"Operations","kind":"typeIdentifier","preciseIdentifier":"s:13MarvelService10OperationsO"},{"text":".","kind":"text"},{"text":"getSeriesByEventId","kind":"typeIdentifier","preciseIdentifier":"s:13MarvelService10OperationsO18getSeriesByEventIdO"},{"text":".","kind":"text"},{"text":"Input","kind":"typeIdentifier","preciseIdentifier":"s:13MarvelService10OperationsO18getSeriesByEventIdO5InputV"},{"text":".","kind":"text"},{"text":"Path","kind":"typeIdentifier","preciseIdentifier":"s:13MarvelService10OperationsO18getSeriesByEventIdO5InputV4PathV"},{"text":", ","kind":"text"},{"text":"query","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"Operations","kind":"typeIdentifier","preciseIdentifier":"s:13MarvelService10OperationsO"},{"text":".","kind":"text"},{"text":"getSeriesByEventId","kind":"typeIdentifier","preciseIdentifier":"s:13MarvelService10OperationsO18getSeriesByEventIdO"},{"text":".","kind":"text"},{"text":"Input","kind":"typeIdentifier","preciseIdentifier":"s:13MarvelService10OperationsO18getSeriesByEventIdO5InputV"},{"text":".","kind":"text"},{"text":"Query","kind":"typeIdentifier","preciseIdentifier":"s:13MarvelService10OperationsO18getSeriesByEventIdO5InputV5QueryV"},{"text":", ","kind":"text"},{"text":"headers","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"Operations","kind":"typeIdentifier","preciseIdentifier":"s:13MarvelService10OperationsO"},{"text":".","kind":"text"},{"text":"getSeriesByEventId","kind":"typeIdentifier","preciseIdentifier":"s:13MarvelService10OperationsO18getSeriesByEventIdO"},{"text":".","kind":"text"},{"text":"Input","kind":"typeIdentifier","preciseIdentifier":"s:13MarvelService10OperationsO18getSeriesByEventIdO5InputV"},{"text":".","kind":"text"},{"text":"Headers","kind":"typeIdentifier","preciseIdentifier":"s:13MarvelService10OperationsO18getSeriesByEventIdO5InputV7HeadersV"},{"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":"getSeriesByEventId","kind":"typeIdentifier","preciseIdentifier":"s:13MarvelService10OperationsO18getSeriesByEventIdO"},{"text":".","kind":"text"},{"text":"Output","kind":"typeIdentifier","preciseIdentifier":"s:13MarvelService10OperationsO18getSeriesByEventIdO6OutputO"}],"roleHeading":"Instance Method","symbolKind":"method","title":"getSeriesByEventId(path:query:headers:)","modules":[{"name":"MarvelService"}]},"hierarchy":{"paths":[["doc:\/\/MarvelService\/documentation\/MarvelService","doc:\/\/MarvelService\/documentation\/MarvelService\/Client"]]},"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/MarvelService\/documentation\/MarvelService\/Client\/getSeriesByEventId(path:query:headers:)"},"primaryContentSections":[{"declarations":[{"platforms":["macOS"],"languages":["swift"],"tokens":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"getSeriesByEventId"},{"kind":"text","text":"("},{"kind":"externalParam","text":"path"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:13MarvelService10OperationsO","text":"Operations","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations"},{"kind":"text","text":"."},{"kind":"typeIdentifier","preciseIdentifier":"s:13MarvelService10OperationsO18getSeriesByEventIdO","text":"getSeriesByEventId","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getSeriesByEventId"},{"kind":"text","text":"."},{"kind":"typeIdentifier","preciseIdentifier":"s:13MarvelService10OperationsO18getSeriesByEventIdO5InputV","text":"Input","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getSeriesByEventId\/Input"},{"kind":"text","text":"."},{"kind":"typeIdentifier","preciseIdentifier":"s:13MarvelService10OperationsO18getSeriesByEventIdO5InputV4PathV","text":"Path","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getSeriesByEventId\/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:13MarvelService10OperationsO18getSeriesByEventIdO","text":"getSeriesByEventId","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getSeriesByEventId"},{"kind":"text","text":"."},{"kind":"typeIdentifier","preciseIdentifier":"s:13MarvelService10OperationsO18getSeriesByEventIdO5InputV","text":"Input","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getSeriesByEventId\/Input"},{"kind":"text","text":"."},{"kind":"typeIdentifier","preciseIdentifier":"s:13MarvelService10OperationsO18getSeriesByEventIdO5InputV5QueryV","text":"Query","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getSeriesByEventId\/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","preciseIdentifier":"s:13MarvelService10OperationsO18getSeriesByEventIdO","text":"getSeriesByEventId","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getSeriesByEventId"},{"kind":"text","text":"."},{"kind":"typeIdentifier","preciseIdentifier":"s:13MarvelService10OperationsO18getSeriesByEventIdO5InputV","text":"Input","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getSeriesByEventId\/Input"},{"kind":"text","text":"."},{"kind":"typeIdentifier","preciseIdentifier":"s:13MarvelService10OperationsO18getSeriesByEventIdO5InputV7HeadersV","text":"Headers","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getSeriesByEventId\/Input\/Headers-swift.struct"},{"kind":"text","text":" = .init()) "},{"kind":"keyword","text":"async"},{"kind":"text","text":" "},{"kind":"keyword","text":"throws"},{"kind":"text","text":" -> "},{"text":"Operations","kind":"typeIdentifier","preciseIdentifier":"s:13MarvelService10OperationsO","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations"},{"kind":"text","text":"."},{"preciseIdentifier":"s:13MarvelService10OperationsO18getSeriesByEventIdO","kind":"typeIdentifier","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getSeriesByEventId","text":"getSeriesByEventId"},{"kind":"text","text":"."},{"preciseIdentifier":"s:13MarvelService10OperationsO18getSeriesByEventIdO6OutputO","kind":"typeIdentifier","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getSeriesByEventId\/Output","text":"Output"}]}],"kind":"declarations"},{"kind":"content","content":[{"type":"heading","anchor":"discussion","level":2,"text":"Discussion"},{"type":"paragraph","inlineContent":[{"type":"text","text":"Fetches lists of comic series in which a specific event takes place, with optional filters."}]},{"name":"Remark","type":"aside","content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"HTTP "},{"code":"GET \/v1\/public\/events\/{eventId}\/series","type":"codeVoice"},{"type":"text","text":"."}]}],"style":"note"},{"style":"note","type":"aside","name":"Remark","content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"Generated from "},{"type":"codeVoice","code":"#\/paths\/\/v1\/public\/events\/{eventId}\/series\/get(getSeriesByEventId)"},{"type":"text","text":"."}]}]}]}],"sections":[],"schemaVersion":{"major":0,"minor":3,"patch":0},"references":{"doc://MarvelService/documentation/MarvelService/Operations/getSeriesByEventId/Input":{"role":"symbol","abstract":[],"kind":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"Input"}],"navigatorTitle":[{"kind":"identifier","text":"Input"}],"type":"topic","title":"Operations.getSeriesByEventId.Input","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getSeriesByEventId\/Input","url":"\/documentation\/marvelservice\/operations\/getseriesbyeventid\/input"},"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":{"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/getSeriesByEventId":{"fragments":[{"text":"enum","kind":"keyword"},{"text":" ","kind":"text"},{"text":"getSeriesByEventId","kind":"identifier"}],"role":"symbol","url":"\/documentation\/marvelservice\/operations\/getseriesbyeventid","kind":"symbol","type":"topic","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getSeriesByEventId","title":"Operations.getSeriesByEventId","abstract":[{"type":"text","text":"Fetches lists of series filtered by an event id."}],"navigatorTitle":[{"text":"getSeriesByEventId","kind":"identifier"}]},"doc://MarvelService/documentation/MarvelService/Client/getSeriesByEventId(path:query:headers:)":{"identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Client\/getSeriesByEventId(path:query:headers:)","url":"\/documentation\/marvelservice\/client\/getseriesbyeventid(path:query:headers:)","abstract":[{"text":"Fetches lists of series filtered by an event id.","type":"text"}],"type":"topic","title":"getSeriesByEventId(path:query:headers:)","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"getSeriesByEventId"},{"kind":"text","text":"("},{"kind":"externalParam","text":"path"},{"kind":"text","text":": "},{"preciseIdentifier":"s:13MarvelService10OperationsO","kind":"typeIdentifier","text":"Operations"},{"kind":"text","text":"."},{"preciseIdentifier":"s:13MarvelService10OperationsO18getSeriesByEventIdO","kind":"typeIdentifier","text":"getSeriesByEventId"},{"kind":"text","text":"."},{"preciseIdentifier":"s:13MarvelService10OperationsO18getSeriesByEventIdO5InputV","kind":"typeIdentifier","text":"Input"},{"kind":"text","text":"."},{"preciseIdentifier":"s:13MarvelService10OperationsO18getSeriesByEventIdO5InputV4PathV","kind":"typeIdentifier","text":"Path"},{"kind":"text","text":", "},{"kind":"externalParam","text":"query"},{"text":": ","kind":"text"},{"text":"Operations","kind":"typeIdentifier","preciseIdentifier":"s:13MarvelService10OperationsO"},{"text":".","kind":"text"},{"text":"getSeriesByEventId","kind":"typeIdentifier","preciseIdentifier":"s:13MarvelService10OperationsO18getSeriesByEventIdO"},{"text":".","kind":"text"},{"preciseIdentifier":"s:13MarvelService10OperationsO18getSeriesByEventIdO5InputV","kind":"typeIdentifier","text":"Input"},{"kind":"text","text":"."},{"kind":"typeIdentifier","preciseIdentifier":"s:13MarvelService10OperationsO18getSeriesByEventIdO5InputV5QueryV","text":"Query"},{"kind":"text","text":", "},{"kind":"externalParam","text":"headers"},{"kind":"text","text":": "},{"text":"Operations","kind":"typeIdentifier","preciseIdentifier":"s:13MarvelService10OperationsO"},{"text":".","kind":"text"},{"text":"getSeriesByEventId","kind":"typeIdentifier","preciseIdentifier":"s:13MarvelService10OperationsO18getSeriesByEventIdO"},{"kind":"text","text":"."},{"text":"Input","kind":"typeIdentifier","preciseIdentifier":"s:13MarvelService10OperationsO18getSeriesByEventIdO5InputV"},{"text":".","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:13MarvelService10OperationsO18getSeriesByEventIdO5InputV7HeadersV","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:13MarvelService10OperationsO18getSeriesByEventIdO","kind":"typeIdentifier","text":"getSeriesByEventId"},{"kind":"text","text":"."},{"preciseIdentifier":"s:13MarvelService10OperationsO18getSeriesByEventIdO6OutputO","kind":"typeIdentifier","text":"Output"}],"kind":"symbol","role":"symbol"},"doc://MarvelService/documentation/MarvelService/Operations/getSeriesByEventId/Input/Path-swift.struct":{"role":"symbol","abstract":[],"kind":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"Path"}],"navigatorTitle":[{"kind":"identifier","text":"Path"}],"type":"topic","title":"Operations.getSeriesByEventId.Input.Path","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getSeriesByEventId\/Input\/Path-swift.struct","url":"\/documentation\/marvelservice\/operations\/getseriesbyeventid\/input\/path-swift.struct"},"doc://MarvelService/documentation/MarvelService/Operations/getSeriesByEventId/Input/Query-swift.struct":{"fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"Query"}],"role":"symbol","url":"\/documentation\/marvelservice\/operations\/getseriesbyeventid\/input\/query-swift.struct","kind":"symbol","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getSeriesByEventId\/Input\/Query-swift.struct","title":"Operations.getSeriesByEventId.Input.Query","abstract":[],"type":"topic","navigatorTitle":[{"text":"Query","kind":"identifier"}]},"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/getSeriesByEventId/Input/Headers-swift.struct":{"url":"\/documentation\/marvelservice\/operations\/getseriesbyeventid\/input\/headers-swift.struct","role":"symbol","navigatorTitle":[{"text":"Headers","kind":"identifier"}],"type":"topic","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getSeriesByEventId\/Input\/Headers-swift.struct","title":"Operations.getSeriesByEventId.Input.Headers","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Headers","kind":"identifier"}],"abstract":[],"kind":"symbol"},"doc://MarvelService/documentation/MarvelService/Operations/getSeriesByEventId/Output":{"fragments":[{"text":"enum","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Output","kind":"identifier"}],"role":"symbol","url":"\/documentation\/marvelservice\/operations\/getseriesbyeventid\/output","kind":"symbol","type":"topic","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getSeriesByEventId\/Output","title":"Operations.getSeriesByEventId.Output","abstract":[],"navigatorTitle":[{"text":"Output","kind":"identifier"}]}}} |