Skip to content

Commit d536901

Browse files
author
json-everything-ci
committed
regenerated api docs
1 parent 32e1beb commit d536901

File tree

6 files changed

+146
-0
lines changed

6 files changed

+146
-0
lines changed

‎_docs/api/JsonLogic/JsonLogic.md

+56
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/JsonPointer.md

+16
Original file line numberDiff line numberDiff line change
@@ -78,16 +78,22 @@ A new pointer.
7878

7979
### Combine(ReadOnlySpan\<PointerSegment\> additionalSegments)
8080

81+
Concatenates additional segments onto the current pointer.
8182

8283
#### Declaration
8384

8485
```c#
8586
public JsonPointer Combine(ReadOnlySpan<PointerSegment> additionalSegments)
8687
```
8788

89+
| Parameter | Type | Description |
90+
|---|---|---|
91+
| additionalSegments | ReadOnlySpan\<PointerSegment\> | The additional segments. |
92+
8893

8994
#### Returns
9095

96+
A new pointer.
9197

9298
### Create(params PointerSegment[] segments)
9399

@@ -114,16 +120,26 @@ This method creates un-encoded pointers only.
114120

115121
### Create(ReadOnlySpan\<PointerSegment\> segments)
116122

123+
Creates a new JSON Pointer from a collection of segments.
117124

118125
#### Declaration
119126

120127
```c#
121128
public static JsonPointer Create(ReadOnlySpan<PointerSegment> segments)
122129
```
123130

131+
| Parameter | Type | Description |
132+
|---|---|---|
133+
| segments | ReadOnlySpan\<PointerSegment\> | A collection of segments. |
134+
124135

125136
#### Returns
126137

138+
The JSON Pointer.
139+
140+
#### Remarks
141+
142+
This method creates un-encoded pointers only.
127143

128144
### Create(Expression\<Func\<T, object\>\> expression, PointerCreationOptions options)
129145

‎_docs/api/JsonSchema.Net.Generation.DataAnnotations/AllowedValuesAttributeHandler.md

+18
Original file line numberDiff line numberDiff line change
@@ -17,16 +17,34 @@ order: "10.06.000"
1717
- IAttributeHandler\<AllowedValuesAttribute\>
1818
- IAttributeHandler
1919

20+
Adds an `enum` keyword for the indicated values.
21+
22+
## Remarks
23+
24+
For NativeAOT scenarios, only primitive JSON types are supported.
2025

2126
## Methods
2227

2328
### AddConstraints(SchemaGenerationContextBase context, Attribute attribute)
2429

30+
Processes the type and any attributes (present on the context), and adds
31+
intents to the context.
2532

2633
#### Declaration
2734

2835
```c#
2936
public void AddConstraints(SchemaGenerationContextBase context, Attribute attribute)
3037
```
3138

39+
| Parameter | Type | Description |
40+
|---|---|---|
41+
| context | SchemaGenerationContextBase | The generation context. |
42+
| attribute | Attribute | The attribute. |
43+
44+
45+
#### Remarks
46+
47+
A common pattern is to implement **Json.Schema.Generation.IAttributeHandler** on the
48+
attribute itself. In this case, the <paramref name="attribute" /> parameter
49+
will be the same instance as the handler and can likely be ignored.
3250

‎_docs/api/JsonSchema.Net.Generation.DataAnnotations/Base64StringAttributeAttributeHandler.md

+20
Original file line numberDiff line numberDiff line change
@@ -19,4 +19,24 @@ order: "10.06.001"
1919
- IAttributeHandler\<Base64StringAttribute\>
2020
- IAttributeHandler
2121

22+
Adds a `format` keyword with `base64`.
23+
24+
## Remarks
25+
26+
By default, `format` is an annotation only. No validation will occur unless configured to do so.
27+
28+
The `base64` format is defined by the OpenAPI 3.1 specification.
29+
30+
## Constructors
31+
32+
### Base64StringAttributeAttributeHandler()
33+
34+
Creates a new **Json.Schema.Generation.DataAnnotations.Base64StringAttributeAttributeHandler**.
35+
36+
#### Declaration
37+
38+
```c#
39+
public Base64StringAttributeAttributeHandler()
40+
```
41+
2242

‎_docs/api/JsonSchema.Net.Generation.DataAnnotations/DeniedValuesAttributeHandler.md

+18
Original file line numberDiff line numberDiff line change
@@ -17,16 +17,34 @@ order: "10.06.003"
1717
- IAttributeHandler\<DeniedValuesAttribute\>
1818
- IAttributeHandler
1919

20+
Adds a `not: {enum}` construct for the indicated values.
21+
22+
## Remarks
23+
24+
For NativeAOT scenarios, only primitive JSON types are supported.
2025

2126
## Methods
2227

2328
### AddConstraints(SchemaGenerationContextBase context, Attribute attribute)
2429

30+
Processes the type and any attributes (present on the context), and adds
31+
intents to the context.
2532

2633
#### Declaration
2734

2835
```c#
2936
public void AddConstraints(SchemaGenerationContextBase context, Attribute attribute)
3037
```
3138

39+
| Parameter | Type | Description |
40+
|---|---|---|
41+
| context | SchemaGenerationContextBase | The generation context. |
42+
| attribute | Attribute | The attribute. |
43+
44+
45+
#### Remarks
46+
47+
A common pattern is to implement **Json.Schema.Generation.IAttributeHandler** on the
48+
attribute itself. In this case, the <paramref name="attribute" /> parameter
49+
will be the same instance as the handler and can likely be ignored.
3250

‎_docs/api/JsonSchema.Net.Generation.DataAnnotations/LengthAttributeHandler.md

+18
Original file line numberDiff line numberDiff line change
@@ -17,16 +17,34 @@ order: "10.06.007"
1717
- IAttributeHandler\<LengthAttribute\>
1818
- IAttributeHandler
1919

20+
Adds `minLength` and `maxLength` keywords.
21+
22+
## Remarks
23+
24+
`minLength` will be not be added if the value is less than or equal to zero.
2025

2126
## Methods
2227

2328
### AddConstraints(SchemaGenerationContextBase context, Attribute attribute)
2429

30+
Processes the type and any attributes (present on the context), and adds
31+
intents to the context.
2532

2633
#### Declaration
2734

2835
```c#
2936
public void AddConstraints(SchemaGenerationContextBase context, Attribute attribute)
3037
```
3138

39+
| Parameter | Type | Description |
40+
|---|---|---|
41+
| context | SchemaGenerationContextBase | The generation context. |
42+
| attribute | Attribute | The attribute. |
43+
44+
45+
#### Remarks
46+
47+
A common pattern is to implement **Json.Schema.Generation.IAttributeHandler** on the
48+
attribute itself. In this case, the <paramref name="attribute" /> parameter
49+
will be the same instance as the handler and can likely be ignored.
3250

0 commit comments

Comments
 (0)