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.8 KiB
JSON

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