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.7 KiB
JSON
1 line
5.7 KiB
JSON
{"sections":[],"abstract":[{"text":"Return only comics which are part of the specified series (accepts a comma-separated list of ids).","type":"text"}],"identifier":{"url":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getComicsByEventId\/Input\/Query-swift.struct\/series","interfaceLanguage":"swift"},"primaryContentSections":[{"kind":"declarations","declarations":[{"languages":["swift"],"platforms":["macOS"],"tokens":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"series","kind":"identifier"},{"text":": [","kind":"text"},{"preciseIdentifier":"s:Si","text":"Int","kind":"typeIdentifier"},{"text":"]?","kind":"text"}]}]},{"kind":"content","content":[{"text":"Discussion","anchor":"discussion","level":2,"type":"heading"},{"name":"Remark","content":[{"inlineContent":[{"type":"text","text":"Generated from "},{"type":"codeVoice","code":"#\/paths\/v1\/public\/events\/{eventId}\/comics\/GET\/query\/series"},{"type":"text","text":"."}],"type":"paragraph"}],"style":"note","type":"aside"}]}],"kind":"symbol","hierarchy":{"paths":[["doc:\/\/MarvelService\/documentation\/MarvelService","doc:\/\/MarvelService\/documentation\/MarvelService\/Operations","doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getComicsByEventId","doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getComicsByEventId\/Input","doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getComicsByEventId\/Input\/Query-swift.struct"]]},"variants":[{"paths":["\/documentation\/marvelservice\/operations\/getcomicsbyeventid\/input\/query-swift.struct\/series"],"traits":[{"interfaceLanguage":"swift"}]}],"metadata":{"symbolKind":"property","role":"symbol","externalID":"s:13MarvelService10OperationsO18getComicsByEventIdO5InputV5QueryV6seriesSaySiGSgvp","roleHeading":"Instance Property","title":"series","fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"series","kind":"identifier"},{"text":": [","kind":"text"},{"preciseIdentifier":"s:Si","text":"Int","kind":"typeIdentifier"},{"text":"]?","kind":"text"}],"modules":[{"name":"MarvelService"}]},"schemaVersion":{"patch":0,"major":0,"minor":3},"references":{"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/getComicsByEventId/Input/Query-swift.struct/series":{"abstract":[{"text":"Return only comics which are part of the specified series (accepts a comma-separated list of ids).","type":"text"}],"role":"symbol","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getComicsByEventId\/Input\/Query-swift.struct\/series","title":"series","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"series"},{"text":": [","kind":"text"},{"text":"Int","kind":"typeIdentifier","preciseIdentifier":"s:Si"},{"text":"]?","kind":"text"}],"kind":"symbol","type":"topic","url":"\/documentation\/marvelservice\/operations\/getcomicsbyeventid\/input\/query-swift.struct\/series"},"doc://MarvelService/documentation/MarvelService/Operations/getComicsByEventId":{"title":"Operations.getComicsByEventId","abstract":[{"type":"text","text":"Fetches lists of comics filtered by an event id."}],"url":"\/documentation\/marvelservice\/operations\/getcomicsbyeventid","navigatorTitle":[{"text":"getComicsByEventId","kind":"identifier"}],"kind":"symbol","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getComicsByEventId","type":"topic","role":"symbol","fragments":[{"text":"enum","kind":"keyword"},{"text":" ","kind":"text"},{"text":"getComicsByEventId","kind":"identifier"}]},"doc://MarvelService/documentation/MarvelService/Operations/getComicsByEventId/Input/Query-swift.struct":{"url":"\/documentation\/marvelservice\/operations\/getcomicsbyeventid\/input\/query-swift.struct","title":"Operations.getComicsByEventId.Input.Query","navigatorTitle":[{"text":"Query","kind":"identifier"}],"type":"topic","abstract":[],"role":"symbol","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getComicsByEventId\/Input\/Query-swift.struct","kind":"symbol","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Query","kind":"identifier"}]},"doc://MarvelService/documentation/MarvelService/Operations/getComicsByEventId/Input":{"title":"Operations.getComicsByEventId.Input","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getComicsByEventId\/Input","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Input","kind":"identifier"}],"kind":"symbol","type":"topic","url":"\/documentation\/marvelservice\/operations\/getcomicsbyeventid\/input","role":"symbol","navigatorTitle":[{"text":"Input","kind":"identifier"}],"abstract":[]},"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"}}} |