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