Skip to content

Commit 5a1ed3b

Browse files
committed
doc: update with the latest changes
1 parent 0b66698 commit 5a1ed3b

File tree

1 file changed

+34
-1
lines changed

1 file changed

+34
-1
lines changed

docs/API.md

Lines changed: 34 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ Omitting this keyword has the same behavior as a value of 0.</p>
3131
<p><a href="https://tools.ietf.org/id/draft-handrews-json-schema-validation-01.html#rfc.section.6.4.4">reference</a></p>
3232
</dd>
3333
<dt><a href="#maxItems">maxItems(max)</a> ⇒ <code>FluentSchema</code></dt>
34-
<dd><p>An array instance is valid against &quot;maxItems&quot; if its size is lower than, or equal to, the value of this keyword.
34+
<dd><p>An array instance is valid against &quot;minItems&quot; if its size is greater than, or equal to, the value of this keyword.
3535
Omitting this keyword has the same behavior as a value of 0.</p>
3636
<p><a href="https://tools.ietf.org/id/draft-handrews-json-schema-validation-01.html#rfc.section.6.4.3">reference</a></p>
3737
</dd>
@@ -82,6 +82,11 @@ It takes an optional boolean which can be used to explicitly set readOnly true/f
8282
It takes an optional boolean which can be used to explicitly set writeOnly true/false.</p>
8383
<p><a href="https://tools.ietf.org/id/draft-handrews-json-schema-validation-01.html#rfc.section.10.3">reference</a></p>
8484
</dd>
85+
<dt><a href="#deprecated">deprecated(isDeprecated)</a> ⇒ <code><a href="#BaseSchema">BaseSchema</a></code></dt>
86+
<dd><p>The value of deprecated can be left empty to indicate the property is deprecated.
87+
It takes an optional boolean which can be used to explicitly set deprecated true/false.</p>
88+
<p><a href="https://json-schema.org/draft/2019-09/json-schema-validation.html#rfc.section.9.3">reference</a></p>
89+
</dd>
8590
<dt><a href="#required">required()</a> ⇒ <code>FluentSchema</code></dt>
8691
<dd><p>Required has to be chained to a property:
8792
Examples:</p>
@@ -273,6 +278,9 @@ Note the property name that the schema is testing will always be a string.</p>
273278
<dt><a href="#only">only(properties)</a> ⇒ <code><a href="#ObjectSchema">ObjectSchema</a></code></dt>
274279
<dd><p>Returns an object schema with only a subset of keys provided</p>
275280
</dd>
281+
<dt><a href="#without">without(properties)</a> ⇒ <code><a href="#ObjectSchema">ObjectSchema</a></code></dt>
282+
<dd><p>Returns an object schema without a subset of keys provided</p>
283+
</dd>
276284
<dt><a href="#definition">definition(name, props)</a> ⇒ <code>FluentSchema</code></dt>
277285
<dd><p>The &quot;definitions&quot; keywords provides a standardized location for schema authors to inline re-usable JSON Schemas into a more general schema.
278286
There are no restrictions placed on the values within the array.</p>
@@ -560,6 +568,20 @@ It takes an optional boolean which can be used to explicitly set writeOnly true/
560568
| --- | --- |
561569
| isWriteOnly | [<code>boolean</code>](#boolean) \| <code>undefined</code> |
562570

571+
<a name="deprecated"></a>
572+
573+
## deprecated(isDeprecated) ⇒ [<code>BaseSchema</code>](#BaseSchema)
574+
The value of deprecated can be left empty to indicate the property is deprecated.
575+
It takes an optional boolean which can be used to explicitly set deprecated true/false.
576+
577+
[reference](https://json-schema.org/draft/2019-09/json-schema-validation.html#rfc.section.9.3)
578+
579+
**Kind**: global function
580+
581+
| Param | Type |
582+
| --- | --- |
583+
| isDeprecated | <code>Boolean</code> |
584+
563585
<a name="required"></a>
564586

565587
## required() ⇒ <code>FluentSchema</code>
@@ -1072,6 +1094,17 @@ Returns an object schema with only a subset of keys provided
10721094
| --- | --- |
10731095
| properties | a list of properties you want to keep |
10741096

1097+
<a name="without"></a>
1098+
1099+
## without(properties) ⇒ [<code>ObjectSchema</code>](#ObjectSchema)
1100+
Returns an object schema without a subset of keys provided
1101+
1102+
**Kind**: global function
1103+
1104+
| Param | Description |
1105+
| --- | --- |
1106+
| properties | a list of properties you dont want to keep |
1107+
10751108
<a name="definition"></a>
10761109

10771110
## definition(name, props) ⇒ <code>FluentSchema</code>

0 commit comments

Comments
 (0)