Files
javier d5bd9feb0a First version of the library documentation (#7)
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>
2025-10-05 18:41:22 +00:00

1 line
5.6 KiB
JSON

{"sections":[],"abstract":[{"type":"text","text":"Return only issues in series whose title matches the input."}],"identifier":{"url":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getComicsByEventId\/Input\/Query-swift.struct\/title","interfaceLanguage":"swift"},"primaryContentSections":[{"declarations":[{"platforms":["macOS"],"tokens":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"title","kind":"identifier"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":"?","kind":"text"}],"languages":["swift"]}],"kind":"declarations"},{"content":[{"type":"heading","level":2,"text":"Discussion","anchor":"discussion"},{"content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"Generated from "},{"type":"codeVoice","code":"#\/paths\/v1\/public\/events\/{eventId}\/comics\/GET\/query\/title"},{"type":"text","text":"."}]}],"name":"Remark","style":"note","type":"aside"}],"kind":"content"}],"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":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/marvelservice\/operations\/getcomicsbyeventid\/input\/query-swift.struct\/title"]}],"metadata":{"roleHeading":"Instance Property","title":"title","modules":[{"name":"MarvelService"}],"symbolKind":"property","externalID":"s:13MarvelService10OperationsO18getComicsByEventIdO5InputV5QueryV5titleSSSgvp","role":"symbol","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"title"},{"kind":"text","text":": "},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":"?","kind":"text"}]},"schemaVersion":{"patch":0,"major":0,"minor":3},"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/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/getComicsByEventId/Input/Query-swift.struct/title":{"abstract":[{"type":"text","text":"Return only issues in series whose title matches the input."}],"role":"symbol","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getComicsByEventId\/Input\/Query-swift.struct\/title","title":"title","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"title"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"text":"?","kind":"text"}],"kind":"symbol","type":"topic","url":"\/documentation\/marvelservice\/operations\/getcomicsbyeventid\/input\/query-swift.struct\/title"},"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":{"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"}]}}}