Skip to content

Commit 1fa2848

Browse files
committed
overview.html: sample API usage
1 parent 8f82d83 commit 1fa2848

File tree

1 file changed

+20
-1
lines changed

1 file changed

+20
-1
lines changed

src/main/javadoc/overview.html

Lines changed: 20 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,25 @@
1919
A JSON Schema validator implementation in Java which aims for correctness and
2020
performance, in that order
2121

22-
<b>TODO</b>
22+
<h2>Sample usage</h2>
23+
24+
<ul>
25+
<li>create a {@link org.eel.kitchen.jsonschema.schema.JsonSchemaFactory};
26+
</li>
27+
<li>create a {@link org.eel.kitchen.jsonschema.schema.JsonSchema} using
28+
that factory;
29+
</li>
30+
<li>for each instance you wish to validate:
31+
<ul>
32+
<li>create a {@link org.eel.kitchen.jsonschema.main.ValidationContext};
33+
</li>
34+
<li>validate using the created schema.</li>
35+
</ul>
36+
</li>
37+
</ul>
38+
39+
<p><b>NOTE:</b> the API is very likely to change in the future! It will be
40+
stabilized once version 0.5.0 is reached.</p>
41+
2342
</body>
2443
</html>

0 commit comments

Comments
 (0)