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
9.1 KiB
JSON

{"hierarchy":{"paths":[["doc:\/\/MarvelService\/documentation\/MarvelService","doc:\/\/MarvelService\/documentation\/MarvelService\/Operations","doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getSeriesByCharacterId","doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getSeriesByCharacterId\/Input","doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getSeriesByCharacterId\/Input\/Query-swift.struct"]]},"identifier":{"url":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getSeriesByCharacterId\/Input\/Query-swift.struct\/contains","interfaceLanguage":"swift"},"schemaVersion":{"major":0,"minor":3,"patch":0},"metadata":{"title":"contains","externalID":"s:13MarvelService10OperationsO22getSeriesByCharacterIdO5InputV5QueryV8containsSayAI0k7PayloadL0OGSgvp","role":"symbol","roleHeading":"Instance Property","modules":[{"name":"MarvelService"}],"symbolKind":"property","fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"contains","kind":"identifier"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:13MarvelService10OperationsO","text":"Operations","kind":"typeIdentifier"},{"text":".","kind":"text"},{"preciseIdentifier":"s:13MarvelService10OperationsO22getSeriesByCharacterIdO","text":"getSeriesByCharacterId","kind":"typeIdentifier"},{"text":".","kind":"text"},{"preciseIdentifier":"s:13MarvelService10OperationsO22getSeriesByCharacterIdO5InputV","text":"Input","kind":"typeIdentifier"},{"text":".","kind":"text"},{"preciseIdentifier":"s:13MarvelService10OperationsO22getSeriesByCharacterIdO5InputV5QueryV","text":"Query","kind":"typeIdentifier"},{"kind":"text","text":"."},{"preciseIdentifier":"s:13MarvelService10OperationsO22getSeriesByCharacterIdO5InputV5QueryV15containsPayloada","kind":"typeIdentifier","text":"containsPayload"},{"kind":"text","text":"?"}]},"kind":"symbol","sections":[],"primaryContentSections":[{"kind":"declarations","declarations":[{"languages":["swift"],"platforms":["macOS"],"tokens":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"contains","kind":"identifier"},{"text":": ","kind":"text"},{"text":"Operations","preciseIdentifier":"s:13MarvelService10OperationsO","kind":"typeIdentifier","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations"},{"text":".","kind":"text"},{"text":"getSeriesByCharacterId","preciseIdentifier":"s:13MarvelService10OperationsO22getSeriesByCharacterIdO","kind":"typeIdentifier","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getSeriesByCharacterId"},{"text":".","kind":"text"},{"preciseIdentifier":"s:13MarvelService10OperationsO22getSeriesByCharacterIdO5InputV","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getSeriesByCharacterId\/Input","text":"Input","kind":"typeIdentifier"},{"text":".","kind":"text"},{"preciseIdentifier":"s:13MarvelService10OperationsO22getSeriesByCharacterIdO5InputV5QueryV","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getSeriesByCharacterId\/Input\/Query-swift.struct","text":"Query","kind":"typeIdentifier"},{"text":".","kind":"text"},{"preciseIdentifier":"s:13MarvelService10OperationsO22getSeriesByCharacterIdO5InputV5QueryV15containsPayloada","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getSeriesByCharacterId\/Input\/Query-swift.struct\/containsPayload","text":"containsPayload","kind":"typeIdentifier"},{"text":"?","kind":"text"}]}]},{"content":[{"text":"Discussion","anchor":"discussion","level":2,"type":"heading"},{"name":"Remark","content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"Generated from "},{"type":"codeVoice","code":"#\/paths\/v1\/public\/characters\/{characterId}\/series\/GET\/query\/contains"},{"type":"text","text":"."}]}],"style":"note","type":"aside"}],"kind":"content"}],"variants":[{"paths":["\/documentation\/marvelservice\/operations\/getseriesbycharacterid\/input\/query-swift.struct\/contains"],"traits":[{"interfaceLanguage":"swift"}]}],"abstract":[{"type":"text","text":"Return only series containing one or more comics with the specified format."}],"references":{"doc://MarvelService/documentation/MarvelService/Operations/getSeriesByCharacterId":{"url":"\/documentation\/marvelservice\/operations\/getseriesbycharacterid","title":"Operations.getSeriesByCharacterId","navigatorTitle":[{"kind":"identifier","text":"getSeriesByCharacterId"}],"type":"topic","abstract":[{"type":"text","text":"Fetches lists of series filtered by a character id."}],"role":"symbol","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getSeriesByCharacterId","kind":"symbol","fragments":[{"kind":"keyword","text":"enum"},{"kind":"text","text":" "},{"kind":"identifier","text":"getSeriesByCharacterId"}]},"doc://MarvelService/documentation/MarvelService/Operations/getSeriesByCharacterId/Input/Query-swift.struct":{"url":"\/documentation\/marvelservice\/operations\/getseriesbycharacterid\/input\/query-swift.struct","title":"Operations.getSeriesByCharacterId.Input.Query","navigatorTitle":[{"kind":"identifier","text":"Query"}],"type":"topic","abstract":[],"role":"symbol","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getSeriesByCharacterId\/Input\/Query-swift.struct","kind":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"Query"}]},"doc://MarvelService/documentation/MarvelService/Operations/getSeriesByCharacterId/Input/Query-swift.struct/containsPayload":{"fragments":[{"text":"typealias","kind":"keyword"},{"text":" ","kind":"text"},{"text":"containsPayload","kind":"identifier"}],"kind":"symbol","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getSeriesByCharacterId\/Input\/Query-swift.struct\/containsPayload","navigatorTitle":[{"text":"containsPayload","kind":"identifier"}],"url":"\/documentation\/marvelservice\/operations\/getseriesbycharacterid\/input\/query-swift.struct\/containspayload","title":"Operations.getSeriesByCharacterId.Input.Query.containsPayload","role":"symbol","abstract":[],"type":"topic"},"doc://MarvelService/documentation/MarvelService/Operations/getSeriesByCharacterId/Input":{"url":"\/documentation\/marvelservice\/operations\/getseriesbycharacterid\/input","title":"Operations.getSeriesByCharacterId.Input","navigatorTitle":[{"kind":"identifier","text":"Input"}],"type":"topic","abstract":[],"role":"symbol","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getSeriesByCharacterId\/Input","kind":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"Input"}]},"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":{"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/getSeriesByCharacterId/Input/Query-swift.struct/contains":{"title":"contains","abstract":[{"text":"Return only series containing one or more comics with the specified format.","type":"text"}],"url":"\/documentation\/marvelservice\/operations\/getseriesbycharacterid\/input\/query-swift.struct\/contains","kind":"symbol","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getSeriesByCharacterId\/Input\/Query-swift.struct\/contains","type":"topic","role":"symbol","fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"contains","kind":"identifier"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:13MarvelService10OperationsO","text":"Operations","kind":"typeIdentifier"},{"text":".","kind":"text"},{"preciseIdentifier":"s:13MarvelService10OperationsO22getSeriesByCharacterIdO","text":"getSeriesByCharacterId","kind":"typeIdentifier"},{"text":".","kind":"text"},{"preciseIdentifier":"s:13MarvelService10OperationsO22getSeriesByCharacterIdO5InputV","text":"Input","kind":"typeIdentifier"},{"text":".","kind":"text"},{"preciseIdentifier":"s:13MarvelService10OperationsO22getSeriesByCharacterIdO5InputV5QueryV","text":"Query","kind":"typeIdentifier"},{"text":".","kind":"text"},{"preciseIdentifier":"s:13MarvelService10OperationsO22getSeriesByCharacterIdO5InputV5QueryV15containsPayloada","text":"containsPayload","kind":"typeIdentifier"},{"text":"?","kind":"text"}]}}}