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