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.2 KiB
JSON
1 line
8.2 KiB
JSON
{"sections":[],"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":"."}],"identifier":{"url":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getSeriesByCharacterId\/Output\/unauthorized-swift.property","interfaceLanguage":"swift"},"primaryContentSections":[{"kind":"declarations","declarations":[{"languages":["swift"],"platforms":["macOS"],"tokens":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"unauthorized","kind":"identifier"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:13MarvelService10OperationsO","text":"Operations","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations","kind":"typeIdentifier"},{"text":".","kind":"text"},{"preciseIdentifier":"s:13MarvelService10OperationsO22getSeriesByCharacterIdO","text":"getSeriesByCharacterId","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getSeriesByCharacterId","kind":"typeIdentifier"},{"text":".","kind":"text"},{"preciseIdentifier":"s:13MarvelService10OperationsO22getSeriesByCharacterIdO6OutputO","text":"Output","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getSeriesByCharacterId\/Output","kind":"typeIdentifier"},{"text":".","kind":"text"},{"preciseIdentifier":"s:13MarvelService10OperationsO22getSeriesByCharacterIdO6OutputO12UnauthorizedV","text":"Unauthorized","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getSeriesByCharacterId\/Output\/Unauthorized-swift.struct","kind":"typeIdentifier"},{"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","name":"Throws","style":"note","content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"An error if "},{"code":"self","type":"codeVoice"},{"type":"text","text":" is not "},{"code":".unauthorized","type":"codeVoice"},{"type":"text","text":"."}]}]},{"type":"aside","name":"See Also","style":"note","content":[{"type":"paragraph","inlineContent":[{"type":"text","text":""},{"code":".unauthorized","type":"codeVoice"},{"type":"text","text":"."}]}]}],"kind":"content"}],"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"]]},"variants":[{"paths":["\/documentation\/marvelservice\/operations\/getseriesbycharacterid\/output\/unauthorized-swift.property"],"traits":[{"interfaceLanguage":"swift"}]}],"metadata":{"symbolKind":"property","role":"symbol","externalID":"s:13MarvelService10OperationsO22getSeriesByCharacterIdO6OutputO12unauthorizedAG12UnauthorizedVvp","title":"unauthorized","roleHeading":"Instance Property","fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"unauthorized","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:13MarvelService10OperationsO22getSeriesByCharacterIdO6OutputO","text":"Output","kind":"typeIdentifier"},{"text":".","kind":"text"},{"preciseIdentifier":"s:13MarvelService10OperationsO22getSeriesByCharacterIdO6OutputO12UnauthorizedV","text":"Unauthorized","kind":"typeIdentifier"}],"modules":[{"name":"MarvelService"}]},"schemaVersion":{"minor":3,"patch":0,"major":0},"references":{"doc://MarvelService/documentation/MarvelService/Operations/getSeriesByCharacterId/Output/Unauthorized-swift.struct":{"navigatorTitle":[{"kind":"identifier","text":"Unauthorized"}],"url":"\/documentation\/marvelservice\/operations\/getseriesbycharacterid\/output\/unauthorized-swift.struct","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getSeriesByCharacterId\/Output\/Unauthorized-swift.struct","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"Unauthorized"}],"role":"symbol","type":"topic","abstract":[],"kind":"symbol","title":"Operations.getSeriesByCharacterId.Output.Unauthorized"},"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":{"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/unauthorized-swift.property":{"url":"\/documentation\/marvelservice\/operations\/getseriesbycharacterid\/output\/unauthorized-swift.property","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getSeriesByCharacterId\/Output\/unauthorized-swift.property","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"unauthorized"},{"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:13MarvelService10OperationsO22getSeriesByCharacterIdO6OutputO12UnauthorizedV","kind":"typeIdentifier","text":"Unauthorized"}],"role":"symbol","type":"topic","abstract":[{"text":"The associated value of the enum case if ","type":"text"},{"type":"codeVoice","code":"self"},{"text":" is ","type":"text"},{"type":"codeVoice","code":".unauthorized"},{"text":".","type":"text"}],"kind":"symbol","title":"unauthorized"},"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"}}} |