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