d5bd9feb0a
This PR contains the work done to write the main article of the `DocC` documentation for the library, which introduces the library as well as explains how to install it and use it. Reviewed-on: #7 Co-authored-by: Javier Cicchelli <javier@rock-n-code.com> Co-committed-by: Javier Cicchelli <javier@rock-n-code.com>
1 line
6.6 KiB
JSON
1 line
6.6 KiB
JSON
{"sections":[],"abstract":[{"type":"text","text":"Fetches lists of stories filtered by a series id."}],"identifier":{"url":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getStoriesBySeriesId","interfaceLanguage":"swift"},"primaryContentSections":[{"declarations":[{"languages":["swift"],"platforms":["macOS"],"tokens":[{"text":"enum","kind":"keyword"},{"text":" ","kind":"text"},{"text":"getStoriesBySeriesId","kind":"identifier"}]}],"kind":"declarations"},{"content":[{"type":"heading","anchor":"overview","level":2,"text":"Overview"},{"type":"paragraph","inlineContent":[{"type":"text","text":"Fetches lists of comic stories from a specific series with optional filters."}]},{"type":"aside","name":"Remark","style":"note","content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"HTTP "},{"type":"codeVoice","code":"GET \/v1\/public\/series\/{seriesId}\/stories"},{"type":"text","text":"."}]}]},{"type":"aside","name":"Remark","style":"note","content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"Generated from "},{"type":"codeVoice","code":"#\/paths\/\/v1\/public\/series\/{seriesId}\/stories\/get(getStoriesBySeriesId)"},{"type":"text","text":"."}]}]}],"kind":"content"}],"kind":"symbol","hierarchy":{"paths":[["doc:\/\/MarvelService\/documentation\/MarvelService","doc:\/\/MarvelService\/documentation\/MarvelService\/Operations"]]},"topicSections":[{"identifiers":["doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getStoriesBySeriesId\/Input"],"anchor":"Structures","generated":true,"title":"Structures"},{"identifiers":["doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getStoriesBySeriesId\/id"],"anchor":"Type-Properties","generated":true,"title":"Type Properties"},{"identifiers":["doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getStoriesBySeriesId\/AcceptableContentType","doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getStoriesBySeriesId\/Output"],"anchor":"Enumerations","generated":true,"title":"Enumerations"}],"metadata":{"symbolKind":"enum","role":"symbol","navigatorTitle":[{"text":"getStoriesBySeriesId","kind":"identifier"}],"externalID":"s:13MarvelService10OperationsO20getStoriesBySeriesIdO","roleHeading":"Enumeration","title":"Operations.getStoriesBySeriesId","fragments":[{"text":"enum","kind":"keyword"},{"text":" ","kind":"text"},{"text":"getStoriesBySeriesId","kind":"identifier"}],"modules":[{"name":"MarvelService"}]},"schemaVersion":{"minor":3,"patch":0,"major":0},"variants":[{"paths":["\/documentation\/marvelservice\/operations\/getstoriesbyseriesid"],"traits":[{"interfaceLanguage":"swift"}]}],"references":{"doc://MarvelService/documentation/MarvelService/Operations":{"fragments":[{"text":"enum","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Operations","kind":"identifier"}],"identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations","kind":"symbol","navigatorTitle":[{"kind":"identifier","text":"Operations"}],"url":"\/documentation\/marvelservice\/operations","title":"Operations","role":"symbol","abstract":[{"text":"API operations, with input and output types, generated from ","type":"text"},{"type":"codeVoice","code":"#\/paths"},{"type":"text","text":" in the OpenAPI document."}],"type":"topic"},"doc://MarvelService/documentation/MarvelService/Operations/getStoriesBySeriesId/Input":{"abstract":[],"role":"symbol","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getStoriesBySeriesId\/Input","navigatorTitle":[{"text":"Input","kind":"identifier"}],"title":"Operations.getStoriesBySeriesId.Input","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Input","kind":"identifier"}],"kind":"symbol","url":"\/documentation\/marvelservice\/operations\/getstoriesbyseriesid\/input","type":"topic"},"doc://MarvelService/documentation/MarvelService/Operations/getStoriesBySeriesId/id":{"url":"\/documentation\/marvelservice\/operations\/getstoriesbyseriesid\/id","title":"id","type":"topic","abstract":[],"role":"symbol","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getStoriesBySeriesId\/id","kind":"symbol","fragments":[{"text":"static","kind":"keyword"},{"text":" ","kind":"text"},{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"id","kind":"identifier"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"}]},"doc://MarvelService/documentation/MarvelService/Operations/getStoriesBySeriesId":{"url":"\/documentation\/marvelservice\/operations\/getstoriesbyseriesid","title":"Operations.getStoriesBySeriesId","navigatorTitle":[{"text":"getStoriesBySeriesId","kind":"identifier"}],"type":"topic","abstract":[{"type":"text","text":"Fetches lists of stories filtered by a series id."}],"role":"symbol","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getStoriesBySeriesId","kind":"symbol","fragments":[{"text":"enum","kind":"keyword"},{"text":" ","kind":"text"},{"text":"getStoriesBySeriesId","kind":"identifier"}]},"doc://MarvelService/documentation/MarvelService":{"identifier":"doc:\/\/MarvelService\/documentation\/MarvelService","kind":"symbol","url":"\/documentation\/marvelservice","title":"MarvelService","role":"collection","abstract":[{"text":"A library that allows the developer to interact with the ","type":"text"},{"type":"strong","inlineContent":[{"text":"Marvel Comics API","type":"text"}]},{"type":"text","text":" backend service."}],"type":"topic"},"doc://MarvelService/documentation/MarvelService/Operations/getStoriesBySeriesId/AcceptableContentType":{"url":"\/documentation\/marvelservice\/operations\/getstoriesbyseriesid\/acceptablecontenttype","title":"Operations.getStoriesBySeriesId.AcceptableContentType","navigatorTitle":[{"text":"AcceptableContentType","kind":"identifier"}],"type":"topic","abstract":[],"role":"symbol","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getStoriesBySeriesId\/AcceptableContentType","kind":"symbol","fragments":[{"text":"enum","kind":"keyword"},{"text":" ","kind":"text"},{"text":"AcceptableContentType","kind":"identifier"}]},"doc://MarvelService/documentation/MarvelService/Operations/getStoriesBySeriesId/Output":{"abstract":[],"role":"symbol","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getStoriesBySeriesId\/Output","navigatorTitle":[{"text":"Output","kind":"identifier"}],"title":"Operations.getStoriesBySeriesId.Output","fragments":[{"text":"enum","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Output","kind":"identifier"}],"kind":"symbol","url":"\/documentation\/marvelservice\/operations\/getstoriesbyseriesid\/output","type":"topic"}}} |