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

{"sections":[],"abstract":[{"text":"Creates a new ","type":"text"},{"code":"NotFound","type":"codeVoice"},{"text":".","type":"text"}],"identifier":{"url":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getSeriesByCharacterId\/Output\/NotFound-swift.struct\/init(body:)","interfaceLanguage":"swift"},"primaryContentSections":[{"declarations":[{"languages":["swift"],"tokens":[{"text":"init","kind":"keyword"},{"text":"(","kind":"text"},{"text":"body","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:13MarvelService10OperationsO","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations","text":"Operations","kind":"typeIdentifier"},{"text":".","kind":"text"},{"text":"getSeriesByCharacterId","preciseIdentifier":"s:13MarvelService10OperationsO22getSeriesByCharacterIdO","kind":"typeIdentifier","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getSeriesByCharacterId"},{"text":".","kind":"text"},{"preciseIdentifier":"s:13MarvelService10OperationsO22getSeriesByCharacterIdO6OutputO","text":"Output","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getSeriesByCharacterId\/Output","kind":"typeIdentifier"},{"text":".","kind":"text"},{"preciseIdentifier":"s:13MarvelService10OperationsO22getSeriesByCharacterIdO6OutputO8NotFoundV","text":"NotFound","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getSeriesByCharacterId\/Output\/NotFound-swift.struct","kind":"typeIdentifier"},{"text":".","kind":"text"},{"text":"Body","preciseIdentifier":"s:13MarvelService10OperationsO22getSeriesByCharacterIdO6OutputO8NotFoundV4BodyO","kind":"typeIdentifier","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getSeriesByCharacterId\/Output\/NotFound-swift.struct\/Body-swift.enum"},{"kind":"text","text":")"}],"platforms":["macOS"]}],"kind":"declarations"},{"kind":"parameters","parameters":[{"content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"Received HTTP response body"}]}],"name":"body"}]}],"kind":"symbol","hierarchy":{"paths":[["doc:\/\/MarvelService\/documentation\/MarvelService","doc:\/\/MarvelService\/documentation\/MarvelService\/Operations","doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getSeriesByCharacterId","doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getSeriesByCharacterId\/Output","doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getSeriesByCharacterId\/Output\/NotFound-swift.struct"]]},"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/marvelservice\/operations\/getseriesbycharacterid\/output\/notfound-swift.struct\/init(body:)"]}],"metadata":{"symbolKind":"init","role":"symbol","externalID":"s:13MarvelService10OperationsO22getSeriesByCharacterIdO6OutputO8NotFoundV4bodyA2I4BodyO_tcfc","roleHeading":"Initializer","title":"init(body:)","fragments":[{"text":"init","kind":"identifier"},{"text":"(","kind":"text"},{"text":"body","kind":"externalParam"},{"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:13MarvelService10OperationsO22getSeriesByCharacterIdO6OutputO","text":"Output","kind":"typeIdentifier"},{"text":".","kind":"text"},{"preciseIdentifier":"s:13MarvelService10OperationsO22getSeriesByCharacterIdO6OutputO8NotFoundV","text":"NotFound","kind":"typeIdentifier"},{"text":".","kind":"text"},{"preciseIdentifier":"s:13MarvelService10OperationsO22getSeriesByCharacterIdO6OutputO8NotFoundV4BodyO","text":"Body","kind":"typeIdentifier"},{"text":")","kind":"text"}],"modules":[{"name":"MarvelService"}]},"schemaVersion":{"minor":3,"patch":0,"major":0},"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/Output":{"url":"\/documentation\/marvelservice\/operations\/getseriesbycharacterid\/output","title":"Operations.getSeriesByCharacterId.Output","navigatorTitle":[{"text":"Output","kind":"identifier"}],"type":"topic","abstract":[],"role":"symbol","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getSeriesByCharacterId\/Output","kind":"symbol","fragments":[{"text":"enum","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Output","kind":"identifier"}]},"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/getSeriesByCharacterId/Output/NotFound-swift.struct/init(body:)":{"title":"init(body:)","abstract":[{"type":"text","text":"Creates a new "},{"type":"codeVoice","code":"NotFound"},{"type":"text","text":"."}],"url":"\/documentation\/marvelservice\/operations\/getseriesbycharacterid\/output\/notfound-swift.struct\/init(body:)","kind":"symbol","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getSeriesByCharacterId\/Output\/NotFound-swift.struct\/init(body:)","type":"topic","role":"symbol","fragments":[{"kind":"identifier","text":"init"},{"kind":"text","text":"("},{"kind":"externalParam","text":"body"},{"kind":"text","text":": "},{"preciseIdentifier":"s:13MarvelService10OperationsO","kind":"typeIdentifier","text":"Operations"},{"kind":"text","text":"."},{"preciseIdentifier":"s:13MarvelService10OperationsO22getSeriesByCharacterIdO","kind":"typeIdentifier","text":"getSeriesByCharacterId"},{"kind":"text","text":"."},{"preciseIdentifier":"s:13MarvelService10OperationsO22getSeriesByCharacterIdO6OutputO","kind":"typeIdentifier","text":"Output"},{"kind":"text","text":"."},{"preciseIdentifier":"s:13MarvelService10OperationsO22getSeriesByCharacterIdO6OutputO8NotFoundV","kind":"typeIdentifier","text":"NotFound"},{"kind":"text","text":"."},{"preciseIdentifier":"s:13MarvelService10OperationsO22getSeriesByCharacterIdO6OutputO8NotFoundV4BodyO","kind":"typeIdentifier","text":"Body"},{"kind":"text","text":")"}]},"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/Output/NotFound-swift.struct":{"abstract":[],"role":"symbol","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getSeriesByCharacterId\/Output\/NotFound-swift.struct","navigatorTitle":[{"text":"NotFound","kind":"identifier"}],"title":"Operations.getSeriesByCharacterId.Output.NotFound","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"NotFound","kind":"identifier"}],"kind":"symbol","url":"\/documentation\/marvelservice\/operations\/getseriesbycharacterid\/output\/notfound-swift.struct","type":"topic"},"doc://MarvelService/documentation/MarvelService/Operations/getSeriesByCharacterId/Output/NotFound-swift.struct/Body-swift.enum":{"abstract":[],"role":"symbol","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getSeriesByCharacterId\/Output\/NotFound-swift.struct\/Body-swift.enum","navigatorTitle":[{"text":"Body","kind":"identifier"}],"title":"Operations.getSeriesByCharacterId.Output.NotFound.Body","fragments":[{"text":"enum","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Body","kind":"identifier"}],"kind":"symbol","url":"\/documentation\/marvelservice\/operations\/getseriesbycharacterid\/output\/notfound-swift.struct\/body-swift.enum","type":"topic"}}}