Skip to content

Commit 0ef4757

Browse files
author
json-everything-ci
committed
regenerated api docs
1 parent 8c6f1fc commit 0ef4757

31 files changed

+181
-27
lines changed

‎_docs/api/JsonLogic/JsonLogic.md‎

Lines changed: 56 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -38,16 +38,23 @@ A `+` rule.
3838

3939
### Add(Rule a, ReadOnlySpan\<Rule\> more)
4040

41+
Creates a `+` ("add") rule.
4142

4243
#### Declaration
4344

4445
```c#
4546
public static Rule Add(Rule a, ReadOnlySpan<Rule> more)
4647
```
4748

49+
| Parameter | Type | Description |
50+
|---|---|---|
51+
| a | Rule | The first rule. |
52+
| more | ReadOnlySpan\<Rule\> | Subsequent rules. |
53+
4854

4955
#### Returns
5056

57+
A `+` rule.
5158

5259
### All(Rule input, Rule rule)
5360

@@ -91,16 +98,23 @@ An `and` rule.
9198

9299
### And(Rule a, ReadOnlySpan\<Rule\> more)
93100

101+
Creates an `and` rule.
94102

95103
#### Declaration
96104

97105
```c#
98106
public static Rule And(Rule a, ReadOnlySpan<Rule> more)
99107
```
100108

109+
| Parameter | Type | Description |
110+
|---|---|---|
111+
| a | Rule | The first rule. |
112+
| more | ReadOnlySpan\<Rule\> | Subsequent rules. |
113+
101114

102115
#### Returns
103116

117+
An `and` rule.
104118

105119
### Apply(JsonNode rule, JsonNode context)
106120

@@ -226,16 +240,23 @@ A `cat` rule.
226240

227241
### Cat(Rule a, ReadOnlySpan\<Rule\> more)
228242

243+
Creates a `cat` ("concatenation") rule.
229244

230245
#### Declaration
231246

232247
```c#
233248
public static Rule Cat(Rule a, ReadOnlySpan<Rule> more)
234249
```
235250

251+
| Parameter | Type | Description |
252+
|---|---|---|
253+
| a | Rule | The first rule. |
254+
| more | ReadOnlySpan\<Rule\> | Subsequent rules. |
255+
236256

237257
#### Returns
238258

259+
A `cat` rule.
239260

240261
### Divide(Rule a, Rule b)
241262

@@ -476,16 +497,23 @@ A `max` rule.
476497

477498
### Max(Rule a, ReadOnlySpan\<Rule\> more)
478499

500+
Creates a `max` rule.
479501

480502
#### Declaration
481503

482504
```c#
483505
public static Rule Max(Rule a, ReadOnlySpan<Rule> more)
484506
```
485507

508+
| Parameter | Type | Description |
509+
|---|---|---|
510+
| a | Rule | The first rule. |
511+
| more | ReadOnlySpan\<Rule\> | Subsequent rules. |
512+
486513

487514
#### Returns
488515

516+
A `max` rule.
489517

490518
### Merge(params Rule[] items)
491519

@@ -528,16 +556,23 @@ A `min` rule.
528556

529557
### Min(Rule a, ReadOnlySpan\<Rule\> more)
530558

559+
Creates a `min` rule.
531560

532561
#### Declaration
533562

534563
```c#
535564
public static Rule Min(Rule a, ReadOnlySpan<Rule> more)
536565
```
537566

567+
| Parameter | Type | Description |
568+
|---|---|---|
569+
| a | Rule | The first rule. |
570+
| more | ReadOnlySpan\<Rule\> | Subsequent rules. |
571+
538572

539573
#### Returns
540574

575+
A `min` rule.
541576

542577
### Missing(params Rule[] components)
543578

@@ -660,16 +695,23 @@ A `*` rule.
660695

661696
### Multiply(Rule a, ReadOnlySpan\<Rule\> more)
662697

698+
Creates a `*` ("multiply") rule.
663699

664700
#### Declaration
665701

666702
```c#
667703
public static Rule Multiply(Rule a, ReadOnlySpan<Rule> more)
668704
```
669705

706+
| Parameter | Type | Description |
707+
|---|---|---|
708+
| a | Rule | The first rule. |
709+
| more | ReadOnlySpan\<Rule\> | Subsequent rules. |
710+
670711

671712
#### Returns
672713

714+
A `*` rule.
673715

674716
### None(Rule input, Rule rule)
675717

@@ -732,16 +774,23 @@ An `or` rule.
732774

733775
### Or(Rule a, ReadOnlySpan\<Rule\> more)
734776

777+
Creates an `or` rule.
735778

736779
#### Declaration
737780

738781
```c#
739782
public static Rule Or(Rule a, ReadOnlySpan<Rule> more)
740783
```
741784

785+
| Parameter | Type | Description |
786+
|---|---|---|
787+
| a | Rule | The first rule. |
788+
| more | ReadOnlySpan\<Rule\> | Subsequent rules. |
789+
742790

743791
#### Returns
744792

793+
An `or` rule.
745794

746795
### Reduce(Rule input, Rule rule, Rule initial)
747796

@@ -887,16 +936,23 @@ A `-` rule.
887936

888937
### Subtract(Rule a, ReadOnlySpan\<Rule\> more)
889938

939+
Creates a `-` ("subtract") rule.
890940

891941
#### Declaration
892942

893943
```c#
894944
public static Rule Subtract(Rule a, ReadOnlySpan<Rule> more)
895945
```
896946

947+
| Parameter | Type | Description |
948+
|---|---|---|
949+
| a | Rule | The first rule. |
950+
| more | ReadOnlySpan\<Rule\> | Subsequent rules. |
951+
897952

898953
#### Returns
899954

955+
A `-` rule.
900956

901957
### Variable(Rule input)
902958

‎_docs/api/JsonPointer.Net/title.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,5 +4,5 @@ bookmark: JsonPointer.Net
44
permalink: /api/JsonPointer.Net/:title/
55
folder: true
66
order: "10.10"
7-
version: "6.0.0"
7+
version: "6.0.1"
88
---

‎_docs/api/JsonSchema.Net/EvaluationContext.md‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,8 @@ The EvaluationContext struct encapsulates all relevant data required for evaluat
2828

2929
| Name | Type | Summary |
3030
|---|---|---|
31-
| **EvaluatedKeywords** | List\<KeywordEvaluation\> | Gets the collection of keyword evaluations that have been performed for the current instance. |
31+
| **CanOptimize** | bool | Gets a value indicating whether the current configuration allows optimization. |
32+
| **EvaluatedKeywords** | KeywordEvaluation[] | Gets the collection of keyword evaluations that have been performed for the current instance. |
3233
| **EvaluationPath** | JsonPointer | Gets or sets a JSON Pointer representing the path through the schemas and across references to the currently evaluated subschema. |
3334
| **Instance** | JsonElement | Gets the JSON element that represents the instance data. |
3435
| **InstanceLocation** | JsonPointer | Gets or sets the JSON Pointer indicating the location of the instance within the JSON document. |

‎_docs/api/JsonSchema.Net/PropertyDependenciesKeyword.md‎

Lines changed: 83 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,83 @@
1+
---
2+
layout: "page"
3+
title: "PropertyDependenciesKeyword Class"
4+
bookmark: "PropertyDependenciesKeyword"
5+
permalink: "/api/JsonSchema.Net/:title/"
6+
order: "10.01.091"
7+
---
8+
**Namespace:** Json.Schema.Keywords
9+
10+
**Inheritance:**
11+
`PropertyDependenciesKeyword`
12+
🡒
13+
`object`
14+
15+
**Implemented interfaces:**
16+
17+
- IKeywordHandler
18+
19+
Handles 'propertyDependencies'.
20+
21+
## Properties
22+
23+
| Name | Type | Summary |
24+
|---|---|---|
25+
| **Name** | string | Gets the name of the handled keyword. |
26+
27+
## Methods
28+
29+
### BuildSubschemas(KeywordData keyword, BuildContext context)
30+
31+
Builds and registers subschemas based on the specified keyword data within the provided build context.
32+
33+
#### Declaration
34+
35+
```c#
36+
public void BuildSubschemas(KeywordData keyword, BuildContext context)
37+
```
38+
39+
| Parameter | Type | Description |
40+
|---|---|---|
41+
| keyword | KeywordData | The keyword data used to determine which subschemas to build. Cannot be null. |
42+
| context | BuildContext | The context in which subschemas are constructed and registered. Cannot be null. |
43+
44+
45+
### Evaluate(KeywordData keyword, EvaluationContext context)
46+
47+
Evaluates the specified keyword using the provided evaluation context and returns the result of the evaluation.
48+
49+
#### Declaration
50+
51+
```c#
52+
public KeywordEvaluation Evaluate(KeywordData keyword, EvaluationContext context)
53+
```
54+
55+
| Parameter | Type | Description |
56+
|---|---|---|
57+
| keyword | KeywordData | The keyword data to be evaluated. Cannot be null. |
58+
| context | EvaluationContext | The context in which the keyword evaluation is performed. Cannot be null. |
59+
60+
61+
#### Returns
62+
63+
A KeywordEvaluation object containing the results of the evaluation.
64+
65+
### ValidateKeywordValue(JsonElement value)
66+
67+
Validates the specified JSON element as a keyword value and optionally returns a value to be shared across the other methods.
68+
69+
#### Declaration
70+
71+
```c#
72+
public object ValidateKeywordValue(JsonElement value)
73+
```
74+
75+
| Parameter | Type | Description |
76+
|---|---|---|
77+
| value | JsonElement | The JSON element to validate and convert. Represents the value to be checked for keyword compliance. |
78+
79+
80+
#### Returns
81+
82+
An object that is shared with the other methods. This object is saved to **Json.Schema.KeywordData.Value**.
83+

‎_docs/api/JsonSchema.Net/PropertyNamesKeyword.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ layout: "page"
33
title: "PropertyNamesKeyword Class"
44
bookmark: "PropertyNamesKeyword"
55
permalink: "/api/JsonSchema.Net/:title/"
6-
order: "10.01.091"
6+
order: "10.01.092"
77
---
88
**Namespace:** Json.Schema.Keywords
99

‎_docs/api/JsonSchema.Net/ReadOnlyKeyword.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ layout: "page"
33
title: "ReadOnlyKeyword Class"
44
bookmark: "ReadOnlyKeyword"
55
permalink: "/api/JsonSchema.Net/:title/"
6-
order: "10.01.092"
6+
order: "10.01.093"
77
---
88
**Namespace:** Json.Schema.Keywords
99

‎_docs/api/JsonSchema.Net/RecursiveAnchorKeyword.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ layout: "page"
33
title: "RecursiveAnchorKeyword Class"
44
bookmark: "RecursiveAnchorKeyword"
55
permalink: "/api/JsonSchema.Net/:title/"
6-
order: "10.01.093"
6+
order: "10.01.094"
77
---
88
**Namespace:** Json.Schema.Keywords.Draft201909
99

‎_docs/api/JsonSchema.Net/RecursiveRefKeyword.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ layout: "page"
33
title: "RecursiveRefKeyword Class"
44
bookmark: "RecursiveRefKeyword"
55
permalink: "/api/JsonSchema.Net/:title/"
6-
order: "10.01.094"
6+
order: "10.01.095"
77
---
88
**Namespace:** Json.Schema.Keywords.Draft201909
99

‎_docs/api/JsonSchema.Net/RefKeyword.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ layout: "page"
33
title: "RefKeyword Class"
44
bookmark: "RefKeyword"
55
permalink: "/api/JsonSchema.Net/:title/"
6-
order: "10.01.095"
6+
order: "10.01.096"
77
---
88
**Namespace:** Json.Schema.Keywords
99

‎_docs/api/JsonSchema.Net/RefResolutionException.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ layout: "page"
33
title: "RefResolutionException Class"
44
bookmark: "RefResolutionException"
55
permalink: "/api/JsonSchema.Net/:title/"
6-
order: "10.01.096"
6+
order: "10.01.097"
77
---
88
**Namespace:** Json.Schema
99

0 commit comments

Comments
 (0)