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
5.6 KiB
JSON
1 line
5.6 KiB
JSON
{"sections":[],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/marvelservice\/operations\/getcharactersbyseriesid\/input\/path-swift.struct\/seriesid"]}],"primaryContentSections":[{"declarations":[{"languages":["swift"],"platforms":["macOS"],"tokens":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"seriesId"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Int","preciseIdentifier":"s:Si"}]}],"kind":"declarations"},{"content":[{"text":"Discussion","level":2,"type":"heading","anchor":"discussion"},{"name":"Remark","style":"note","type":"aside","content":[{"type":"paragraph","inlineContent":[{"text":"Generated from ","type":"text"},{"code":"#\/paths\/v1\/public\/series\/{seriesId}\/characters\/GET\/path\/seriesId","type":"codeVoice"},{"text":".","type":"text"}]}]}],"kind":"content"}],"schemaVersion":{"minor":3,"major":0,"patch":0},"abstract":[{"text":"A series id.","type":"text"}],"hierarchy":{"paths":[["doc:\/\/MarvelService\/documentation\/MarvelService","doc:\/\/MarvelService\/documentation\/MarvelService\/Operations","doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getCharactersBySeriesId","doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getCharactersBySeriesId\/Input","doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getCharactersBySeriesId\/Input\/Path-swift.struct"]]},"identifier":{"url":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getCharactersBySeriesId\/Input\/Path-swift.struct\/seriesId","interfaceLanguage":"swift"},"kind":"symbol","metadata":{"symbolKind":"property","role":"symbol","externalID":"s:13MarvelService10OperationsO23getCharactersBySeriesIdO5InputV4PathV06seriesH0Sivp","roleHeading":"Instance Property","title":"seriesId","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"seriesId"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Int","preciseIdentifier":"s:Si"}],"modules":[{"name":"MarvelService"}]},"references":{"doc://MarvelService/documentation/MarvelService/Operations/getCharactersBySeriesId/Input/Path-swift.struct/seriesId":{"url":"\/documentation\/marvelservice\/operations\/getcharactersbyseriesid\/input\/path-swift.struct\/seriesid","title":"seriesId","type":"topic","abstract":[{"text":"A series id.","type":"text"}],"role":"symbol","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getCharactersBySeriesId\/Input\/Path-swift.struct\/seriesId","kind":"symbol","fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"seriesId","kind":"identifier"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:Si","text":"Int","kind":"typeIdentifier"}]},"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":{"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/getCharactersBySeriesId/Input":{"url":"\/documentation\/marvelservice\/operations\/getcharactersbyseriesid\/input","title":"Operations.getCharactersBySeriesId.Input","navigatorTitle":[{"kind":"identifier","text":"Input"}],"type":"topic","abstract":[],"role":"symbol","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getCharactersBySeriesId\/Input","kind":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"Input"}]},"doc://MarvelService/documentation/MarvelService/Operations/getCharactersBySeriesId":{"abstract":[{"text":"Fetches lists of characters filtered by a series id.","type":"text"}],"role":"symbol","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getCharactersBySeriesId","navigatorTitle":[{"kind":"identifier","text":"getCharactersBySeriesId"}],"title":"Operations.getCharactersBySeriesId","fragments":[{"text":"enum","kind":"keyword"},{"text":" ","kind":"text"},{"text":"getCharactersBySeriesId","kind":"identifier"}],"kind":"symbol","url":"\/documentation\/marvelservice\/operations\/getcharactersbyseriesid","type":"topic"},"doc://MarvelService/documentation/MarvelService/Operations/getCharactersBySeriesId/Input/Path-swift.struct":{"url":"\/documentation\/marvelservice\/operations\/getcharactersbyseriesid\/input\/path-swift.struct","title":"Operations.getCharactersBySeriesId.Input.Path","navigatorTitle":[{"text":"Path","kind":"identifier"}],"type":"topic","abstract":[],"role":"symbol","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getCharactersBySeriesId\/Input\/Path-swift.struct","kind":"symbol","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Path","kind":"identifier"}]}}} |