summaryrefslogtreecommitdiff
path: root/site
diff options
context:
space:
mode:
authorpommicket <pommicket@gmail.com>2025-09-09 01:06:37 -0400
committerpommicket <pommicket@gmail.com>2025-09-09 01:06:37 -0400
commit5267d35f4bb57cfa90daf3eb4d82271d2b48a493 (patch)
tree1deb6d4327065971a29b73e57bb71d3827a2da05 /site
parented8ab621f24de687b199e1305d773bffb24e3842 (diff)
Improve schema API, more tests
Diffstat (limited to 'site')
-rw-r--r--site/spec.html17
1 files changed, 10 insertions, 7 deletions
diff --git a/site/spec.html b/site/spec.html
index 706e019..0222acc 100644
--- a/site/spec.html
+++ b/site/spec.html
@@ -674,16 +674,19 @@ and for my.nephews.car.id is String (no schema key matches, so the default of St
Returns an empty configuration if there are no descendants of <code>key</code> defined.
</li>
<li>
- <code>check_against_schema(conf: Configuration, schema: Configuration) -&gt; Configuration</code> (<i>optional</i>)<br>
- Check that <code>schema</code>
- is a valid schema and that <code>conf</code> follows it,
- returning an error with detailed information
- if not. If successful, returns a configuration with default values filled out.
- </li>
- <li>
<code>merge(conf_a: Configuration, conf_b: Configuration) -&gt; Configuration</code><br>
Returns the result of merging <code>conf_b</code> into <code>conf_a</code>.
</li>
+ <li>
+ <code>parse_schema(conf: Configuration) -&gt; Schema</code> (<i>optional</i>)<br>
+ Parse <code>conf</code> as a schema, returning an error if it is invalid.
+ </li>
+ <li>
+ <code>check_against_schema(conf: Configuration, schema: Schema) -&gt; Configuration</code> (<i>optional</i>)<br>
+ Check <code>conf</code> follows <code>schema</code>,
+ returning an error with detailed information
+ if not. If successful, returns a configuration with default values filled out.
+ </li>
</ul>
<h2>Examples</h2>