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.7 KiB
JSON
1 line
6.7 KiB
JSON
{"hierarchy":{"paths":[["doc:\/\/MarvelService\/documentation\/MarvelService","doc:\/\/MarvelService\/documentation\/MarvelService\/Operations","doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getComicsByEventId","doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getComicsByEventId\/Input"]]},"identifier":{"url":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getComicsByEventId\/Input\/headers-swift.property","interfaceLanguage":"swift"},"schemaVersion":{"patch":0,"minor":3,"major":0},"sections":[],"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"headers","kind":"identifier"},{"text":": ","kind":"text"},{"text":"Operations","kind":"typeIdentifier","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations","preciseIdentifier":"s:13MarvelService10OperationsO"},{"text":".","kind":"text"},{"text":"getComicsByEventId","kind":"typeIdentifier","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getComicsByEventId","preciseIdentifier":"s:13MarvelService10OperationsO18getComicsByEventIdO"},{"text":".","kind":"text"},{"identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getComicsByEventId\/Input","preciseIdentifier":"s:13MarvelService10OperationsO18getComicsByEventIdO5InputV","text":"Input","kind":"typeIdentifier"},{"text":".","kind":"text"},{"identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getComicsByEventId\/Input\/Headers-swift.struct","preciseIdentifier":"s:13MarvelService10OperationsO18getComicsByEventIdO5InputV7HeadersV","text":"Headers","kind":"typeIdentifier"}],"platforms":["macOS"],"languages":["swift"]}]}],"variants":[{"paths":["\/documentation\/marvelservice\/operations\/getcomicsbyeventid\/input\/headers-swift.property"],"traits":[{"interfaceLanguage":"swift"}]}],"metadata":{"fragments":[{"kind":"keyword","text":"var"},{"text":" ","kind":"text"},{"text":"headers","kind":"identifier"},{"text":": ","kind":"text"},{"text":"Operations","kind":"typeIdentifier","preciseIdentifier":"s:13MarvelService10OperationsO"},{"text":".","kind":"text"},{"text":"getComicsByEventId","kind":"typeIdentifier","preciseIdentifier":"s:13MarvelService10OperationsO18getComicsByEventIdO"},{"text":".","kind":"text"},{"text":"Input","kind":"typeIdentifier","preciseIdentifier":"s:13MarvelService10OperationsO18getComicsByEventIdO5InputV"},{"text":".","kind":"text"},{"text":"Headers","kind":"typeIdentifier","preciseIdentifier":"s:13MarvelService10OperationsO18getComicsByEventIdO5InputV7HeadersV"}],"role":"symbol","symbolKind":"property","roleHeading":"Instance Property","title":"headers","modules":[{"name":"MarvelService"}],"externalID":"s:13MarvelService10OperationsO18getComicsByEventIdO5InputV7headersAG7HeadersVvp"},"kind":"symbol","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/headers-swift.property":{"abstract":[],"role":"symbol","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getComicsByEventId\/Input\/headers-swift.property","title":"headers","fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"headers","kind":"identifier"},{"text":": ","kind":"text"},{"text":"Operations","kind":"typeIdentifier","preciseIdentifier":"s:13MarvelService10OperationsO"},{"text":".","kind":"text"},{"text":"getComicsByEventId","kind":"typeIdentifier","preciseIdentifier":"s:13MarvelService10OperationsO18getComicsByEventIdO"},{"text":".","kind":"text"},{"text":"Input","kind":"typeIdentifier","preciseIdentifier":"s:13MarvelService10OperationsO18getComicsByEventIdO5InputV"},{"text":".","kind":"text"},{"text":"Headers","kind":"typeIdentifier","preciseIdentifier":"s:13MarvelService10OperationsO18getComicsByEventIdO5InputV7HeadersV"}],"kind":"symbol","url":"\/documentation\/marvelservice\/operations\/getcomicsbyeventid\/input\/headers-swift.property","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/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":{"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/Headers-swift.struct":{"url":"\/documentation\/marvelservice\/operations\/getcomicsbyeventid\/input\/headers-swift.struct","title":"Operations.getComicsByEventId.Input.Headers","navigatorTitle":[{"text":"Headers","kind":"identifier"}],"type":"topic","abstract":[],"role":"symbol","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getComicsByEventId\/Input\/Headers-swift.struct","kind":"symbol","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Headers","kind":"identifier"}]}}} |