diff options
| author | rebortg <github@ghlr.de> | 2024-12-19 12:34:07 +0100 |
|---|---|---|
| committer | rebortg <github@ghlr.de> | 2025-01-08 21:21:59 +0000 |
| commit | 80a79c9bc90fefa59b6e1a26684aa5dac0638a4f (patch) | |
| tree | c10481f5b5d2d22a5a0e3f7916cce6bde35e7041 /src/reference_tree.mli | |
| parent | acfac8d809d526e9e5af1ab26cbe093e45ff9f11 (diff) | |
| download | vyos1x-config-80a79c9bc90fefa59b6e1a26684aa5dac0638a4f.tar.gz vyos1x-config-80a79c9bc90fefa59b6e1a26684aa5dac0638a4f.zip | |
T6342: add parsing of docs element
Diffstat (limited to 'src/reference_tree.mli')
| -rw-r--r-- | src/reference_tree.mli | 13 |
1 files changed, 13 insertions, 0 deletions
diff --git a/src/reference_tree.mli b/src/reference_tree.mli index a8d4efa..7025a0a 100644 --- a/src/reference_tree.mli +++ b/src/reference_tree.mli @@ -9,6 +9,18 @@ type completion_help_type = | Script of string [@name "script"] [@@deriving yojson] +type doc_hints = { + text: string; + hint_type: string; + } [@@deriving yojson] + +type docs = { + headline: string; + text: string; + usageExample: string; + hints: doc_hints list; + } [@@deriving to_yojson] + type ref_node_data = { node_type: node_type; constraints: Value_checker.value_constraint list; @@ -24,6 +36,7 @@ type ref_node_data = { default_value: string option; hidden: bool; secret: bool; + docs: docs; } [@@deriving yojson] type t = ref_node_data Vytree.t [@@deriving yojson] |