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