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
8.0 KiB
JSON
1 line
8.0 KiB
JSON
{"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"notFound"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:13MarvelService10OperationsO","text":"Operations","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations"},{"kind":"text","text":"."},{"kind":"typeIdentifier","preciseIdentifier":"s:13MarvelService10OperationsO22getCharactersByEventIdO","text":"getCharactersByEventId","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getCharactersByEventId"},{"kind":"text","text":"."},{"kind":"typeIdentifier","preciseIdentifier":"s:13MarvelService10OperationsO22getCharactersByEventIdO6OutputO","text":"Output","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getCharactersByEventId\/Output"},{"kind":"text","text":"."},{"kind":"typeIdentifier","preciseIdentifier":"s:13MarvelService10OperationsO22getCharactersByEventIdO6OutputO8NotFoundV","text":"NotFound","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getCharactersByEventId\/Output\/NotFound-swift.struct"},{"kind":"text","text":" { "},{"kind":"keyword","text":"get"},{"kind":"text","text":" "},{"kind":"keyword","text":"throws"},{"kind":"text","text":" }"}],"platforms":["macOS"],"languages":["swift"]}]},{"content":[{"text":"Discussion","level":2,"anchor":"discussion","type":"heading"},{"content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"An error if "},{"code":"self","type":"codeVoice"},{"type":"text","text":" is not "},{"code":".notFound","type":"codeVoice"},{"type":"text","text":"."}]}],"style":"note","type":"aside","name":"Throws"},{"content":[{"type":"paragraph","inlineContent":[{"type":"text","text":""},{"code":".notFound","type":"codeVoice"},{"type":"text","text":"."}]}],"style":"note","type":"aside","name":"See Also"}],"kind":"content"}],"hierarchy":{"paths":[["doc:\/\/MarvelService\/documentation\/MarvelService","doc:\/\/MarvelService\/documentation\/MarvelService\/Operations","doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getCharactersByEventId","doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getCharactersByEventId\/Output"]]},"schemaVersion":{"minor":3,"patch":0,"major":0},"abstract":[{"type":"text","text":"The associated value of the enum case if "},{"code":"self","type":"codeVoice"},{"text":" is ","type":"text"},{"code":".notFound","type":"codeVoice"},{"text":".","type":"text"}],"variants":[{"paths":["\/documentation\/marvelservice\/operations\/getcharactersbyeventid\/output\/notfound-swift.property"],"traits":[{"interfaceLanguage":"swift"}]}],"kind":"symbol","metadata":{"title":"notFound","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"notFound"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:13MarvelService10OperationsO","text":"Operations"},{"kind":"text","text":"."},{"kind":"typeIdentifier","preciseIdentifier":"s:13MarvelService10OperationsO22getCharactersByEventIdO","text":"getCharactersByEventId"},{"kind":"text","text":"."},{"kind":"typeIdentifier","preciseIdentifier":"s:13MarvelService10OperationsO22getCharactersByEventIdO6OutputO","text":"Output"},{"kind":"text","text":"."},{"preciseIdentifier":"s:13MarvelService10OperationsO22getCharactersByEventIdO6OutputO8NotFoundV","text":"NotFound","kind":"typeIdentifier"}],"externalID":"s:13MarvelService10OperationsO22getCharactersByEventIdO6OutputO8notFoundAG03NotK0Vvp","roleHeading":"Instance Property","role":"symbol","symbolKind":"property","modules":[{"name":"MarvelService"}]},"identifier":{"url":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getCharactersByEventId\/Output\/notFound-swift.property","interfaceLanguage":"swift"},"sections":[],"references":{"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":{"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/getCharactersByEventId/Output":{"title":"Operations.getCharactersByEventId.Output","abstract":[],"url":"\/documentation\/marvelservice\/operations\/getcharactersbyeventid\/output","navigatorTitle":[{"text":"Output","kind":"identifier"}],"kind":"symbol","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getCharactersByEventId\/Output","type":"topic","role":"symbol","fragments":[{"kind":"keyword","text":"enum"},{"kind":"text","text":" "},{"kind":"identifier","text":"Output"}]},"doc://MarvelService/documentation/MarvelService/Operations/getCharactersByEventId/Output/notFound-swift.property":{"identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getCharactersByEventId\/Output\/notFound-swift.property","title":"notFound","fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"notFound"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:13MarvelService10OperationsO","text":"Operations","kind":"typeIdentifier"},{"text":".","kind":"text"},{"preciseIdentifier":"s:13MarvelService10OperationsO22getCharactersByEventIdO","text":"getCharactersByEventId","kind":"typeIdentifier"},{"text":".","kind":"text"},{"preciseIdentifier":"s:13MarvelService10OperationsO22getCharactersByEventIdO6OutputO","text":"Output","kind":"typeIdentifier"},{"text":".","kind":"text"},{"preciseIdentifier":"s:13MarvelService10OperationsO22getCharactersByEventIdO6OutputO8NotFoundV","text":"NotFound","kind":"typeIdentifier"}],"kind":"symbol","type":"topic","url":"\/documentation\/marvelservice\/operations\/getcharactersbyeventid\/output\/notfound-swift.property","role":"symbol","abstract":[{"type":"text","text":"The associated value of the enum case if "},{"type":"codeVoice","code":"self"},{"text":" is ","type":"text"},{"type":"codeVoice","code":".notFound"},{"text":".","type":"text"}]},"doc://MarvelService/documentation/MarvelService/Operations/getCharactersByEventId":{"url":"\/documentation\/marvelservice\/operations\/getcharactersbyeventid","title":"Operations.getCharactersByEventId","navigatorTitle":[{"kind":"identifier","text":"getCharactersByEventId"}],"type":"topic","abstract":[{"type":"text","text":"Fetches lists of characters filtered by an event id."}],"role":"symbol","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getCharactersByEventId","kind":"symbol","fragments":[{"kind":"keyword","text":"enum"},{"kind":"text","text":" "},{"kind":"identifier","text":"getCharactersByEventId"}]},"doc://MarvelService/documentation/MarvelService/Operations/getCharactersByEventId/Output/NotFound-swift.struct":{"url":"\/documentation\/marvelservice\/operations\/getcharactersbyeventid\/output\/notfound-swift.struct","title":"Operations.getCharactersByEventId.Output.NotFound","navigatorTitle":[{"text":"NotFound","kind":"identifier"}],"type":"topic","abstract":[],"role":"symbol","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getCharactersByEventId\/Output\/NotFound-swift.struct","kind":"symbol","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"NotFound","kind":"identifier"}]}}} |