Skip to content

Commit 6c273f2

Browse files
author
json-everything-ci
committed
regenerated api docs
1 parent 223b444 commit 6c273f2

File tree

8 files changed

+119
-57
lines changed

8 files changed

+119
-57
lines changed

‎_docs/api/JsonLogic/JsonLogic.md

-56
Original file line numberDiff line numberDiff line change
@@ -38,23 +38,16 @@ A `+` rule.
3838

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

41-
Creates a `+` ("add") rule.
4241

4342
#### Declaration
4443

4544
```c#
4645
public static Rule Add(Rule a, ReadOnlySpan<Rule> more)
4746
```
4847

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

5549
#### Returns
5650

57-
A `+` rule.
5851

5952
### All(Rule input, Rule rule)
6053

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

9992
### And(Rule a, ReadOnlySpan\<Rule\> more)
10093

101-
Creates an `and` rule.
10294

10395
#### Declaration
10496

10597
```c#
10698
public static Rule And(Rule a, ReadOnlySpan<Rule> more)
10799
```
108100

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

115102
#### Returns
116103

117-
An `and` rule.
118104

119105
### Apply(JsonNode rule, JsonNode context)
120106

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

241227
### Cat(Rule a, ReadOnlySpan\<Rule\> more)
242228

243-
Creates a `cat` ("concatenation") rule.
244229

245230
#### Declaration
246231

247232
```c#
248233
public static Rule Cat(Rule a, ReadOnlySpan<Rule> more)
249234
```
250235

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

257237
#### Returns
258238

259-
A `cat` rule.
260239

261240
### Divide(Rule a, Rule b)
262241

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

498477
### Max(Rule a, ReadOnlySpan\<Rule\> more)
499478

500-
Creates a `max` rule.
501479

502480
#### Declaration
503481

504482
```c#
505483
public static Rule Max(Rule a, ReadOnlySpan<Rule> more)
506484
```
507485

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

514487
#### Returns
515488

516-
A `max` rule.
517489

518490
### Merge(params Rule[] items)
519491

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

557529
### Min(Rule a, ReadOnlySpan\<Rule\> more)
558530

559-
Creates a `min` rule.
560531

561532
#### Declaration
562533

563534
```c#
564535
public static Rule Min(Rule a, ReadOnlySpan<Rule> more)
565536
```
566537

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

573539
#### Returns
574540

575-
A `min` rule.
576541

577542
### Missing(params Rule[] components)
578543

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

696661
### Multiply(Rule a, ReadOnlySpan\<Rule\> more)
697662

698-
Creates a `*` ("multiply") rule.
699663

700664
#### Declaration
701665

702666
```c#
703667
public static Rule Multiply(Rule a, ReadOnlySpan<Rule> more)
704668
```
705669

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

712671
#### Returns
713672

714-
A `*` rule.
715673

716674
### None(Rule input, Rule rule)
717675

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

775733
### Or(Rule a, ReadOnlySpan\<Rule\> more)
776734

777-
Creates an `or` rule.
778735

779736
#### Declaration
780737

781738
```c#
782739
public static Rule Or(Rule a, ReadOnlySpan<Rule> more)
783740
```
784741

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

791743
#### Returns
792744

793-
An `or` rule.
794745

795746
### Reduce(Rule input, Rule rule, Rule initial)
796747

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

937888
### Subtract(Rule a, ReadOnlySpan\<Rule\> more)
938889

939-
Creates a `-` ("subtract") rule.
940890

941891
#### Declaration
942892

943893
```c#
944894
public static Rule Subtract(Rule a, ReadOnlySpan<Rule> more)
945895
```
946896

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

953898
#### Returns
954899

955-
A `-` rule.
956900

957901
### Variable(Rule input)
958902

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

+39
Original file line numberDiff line numberDiff line change
@@ -305,6 +305,25 @@ public JsonPointer GetSubPointer(Range range)
305305

306306
A new pointer.
307307

308+
### Parse(ReadOnlySpan\<char\> source)
309+
310+
Parses a JSON Pointer from a string.
311+
312+
#### Declaration
313+
314+
```c#
315+
public static JsonPointer Parse(ReadOnlySpan<char> source)
316+
```
317+
318+
| Parameter | Type | Description |
319+
|---|---|---|
320+
| source | ReadOnlySpan\<char\> | The source string. |
321+
322+
323+
#### Returns
324+
325+
A JSON Pointer.
326+
308327
### Parse(string source)
309328

310329
Parses a JSON Pointer from a string.
@@ -359,6 +378,26 @@ public bool TryEvaluate(JsonNode root, out JsonNode result)
359378

360379
true if a value exists at the indicate path; false otherwise.
361380

381+
### TryParse(ReadOnlySpan\<char\> source, out JsonPointer pointer)
382+
383+
Parses a JSON Pointer from a string.
384+
385+
#### Declaration
386+
387+
```c#
388+
public static bool TryParse(ReadOnlySpan<char> source, out JsonPointer pointer)
389+
```
390+
391+
| Parameter | Type | Description |
392+
|---|---|---|
393+
| source | ReadOnlySpan\<char\> | The source string. |
394+
| pointer | out JsonPointer | The resulting pointer. |
395+
396+
397+
#### Returns
398+
399+
`true` if the parse was successful; `false` otherwise.
400+
362401
### TryParse(string source, out JsonPointer pointer)
363402

364403
Parses a JSON Pointer from a string.

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

+1-1
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: "5.2.0"
7+
version: "5.3.0"
88
---

‎_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

‎_docs/release-notes/rn-json-pointer.md

+5
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,11 @@ title: JsonPointer.Net
44
icon: fas fa-tag
55
order: "09.10"
66
---
7+
# [5.3.0](https://github.com/json-everything/json-everything/pull/850) {#release-pointer-5.3.0}
8+
9+
[#849](https://github.com/json-everything/json-everything/issues/849) - Avoid memory leak in, and improve performance of JsonPointer.ToString() courtesy of [@cptjazz](https://github.com/cptjazz).
10+
[#855](https://github.com/json-everything/json-everything/issues/855) - Performance improvements for JsonPointer.Parse()/TryParse() courtesy of [@cptjazz](https://github.com/cptjazz).
11+
712
# [5.2.0](https://github.com/gregsdennis/json-everything/pull/848) {#release-pointer-5.2.0}
813

914
[#843](https://github.com/json-everything/json-everything/pull/843) - Performance improvements courtesy of [@cptjazz](https://github.com/cptjazz).

0 commit comments

Comments
 (0)