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