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
{"hierarchy":{"paths":[["doc:\/\/MarvelService\/documentation\/MarvelService","doc:\/\/MarvelService\/documentation\/MarvelService\/Operations","doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getSeriesByEventId","doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getSeriesByEventId\/Input","doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getSeriesByEventId\/Input\/Query-swift.struct"]]},"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getSeriesByEventId\/Input\/Query-swift.struct\/offset"},"schemaVersion":{"minor":3,"major":0,"patch":0},"metadata":{"title":"offset","fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"offset","kind":"identifier"},{"text":": ","kind":"text"},{"text":"Int","preciseIdentifier":"s:Si","kind":"typeIdentifier"},{"text":"?","kind":"text"}],"role":"symbol","roleHeading":"Instance Property","externalID":"s:13MarvelService10OperationsO18getSeriesByEventIdO5InputV5QueryV6offsetSiSgvp","symbolKind":"property","modules":[{"name":"MarvelService"}]},"kind":"symbol","sections":[],"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"offset","kind":"identifier"},{"text":": ","kind":"text"},{"text":"Int","preciseIdentifier":"s:Si","kind":"typeIdentifier"},{"text":"?","kind":"text"}],"platforms":["macOS"],"languages":["swift"]}]},{"content":[{"anchor":"discussion","level":2,"text":"Discussion","type":"heading"},{"style":"note","name":"Remark","type":"aside","content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"Generated from "},{"code":"#\/paths\/v1\/public\/events\/{eventId}\/series\/GET\/query\/offset","type":"codeVoice"},{"type":"text","text":"."}]}]}],"kind":"content"}],"variants":[{"paths":["\/documentation\/marvelservice\/operations\/getseriesbyeventid\/input\/query-swift.struct\/offset"],"traits":[{"interfaceLanguage":"swift"}]}],"abstract":[{"text":"Skip the specified number of resources in the result set.","type":"text"}],"references":{"doc://MarvelService/documentation/MarvelService/Operations/getSeriesByEventId/Input/Query-swift.struct/offset":{"identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getSeriesByEventId\/Input\/Query-swift.struct\/offset","title":"offset","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"offset"},{"kind":"text","text":": "},{"preciseIdentifier":"s:Si","kind":"typeIdentifier","text":"Int"},{"kind":"text","text":"?"}],"kind":"symbol","type":"topic","url":"\/documentation\/marvelservice\/operations\/getseriesbyeventid\/input\/query-swift.struct\/offset","role":"symbol","abstract":[{"text":"Skip the specified number of resources in the result set.","type":"text"}]},"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/getSeriesByEventId":{"abstract":[{"type":"text","text":"Fetches lists of series filtered by an event id."}],"role":"symbol","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getSeriesByEventId","navigatorTitle":[{"kind":"identifier","text":"getSeriesByEventId"}],"title":"Operations.getSeriesByEventId","fragments":[{"kind":"keyword","text":"enum"},{"kind":"text","text":" "},{"kind":"identifier","text":"getSeriesByEventId"}],"kind":"symbol","url":"\/documentation\/marvelservice\/operations\/getseriesbyeventid","type":"topic"},"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/getSeriesByEventId/Input/Query-swift.struct":{"identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getSeriesByEventId\/Input\/Query-swift.struct","title":"Operations.getSeriesByEventId.Input.Query","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Query","kind":"identifier"}],"kind":"symbol","type":"topic","url":"\/documentation\/marvelservice\/operations\/getseriesbyeventid\/input\/query-swift.struct","role":"symbol","navigatorTitle":[{"text":"Query","kind":"identifier"}],"abstract":[]},"doc://MarvelService/documentation/MarvelService/Operations/getSeriesByEventId/Input":{"title":"Operations.getSeriesByEventId.Input","abstract":[],"url":"\/documentation\/marvelservice\/operations\/getseriesbyeventid\/input","navigatorTitle":[{"kind":"identifier","text":"Input"}],"kind":"symbol","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getSeriesByEventId\/Input","type":"topic","role":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"Input"}]}}} |