Files
marvel-service/docs/data/documentation/marvelservice/operations/getcharacterbyid/output/forbidden-swift.property.json
T
javier d5bd9feb0a First version of the library documentation (#7)
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>
2025-10-05 18:41:22 +00:00

1 line
7.8 KiB
JSON

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