Skip to content

Commit 56bd1c9

Browse files
author
json-everything-ci
committed
regenerated api docs
1 parent ebfa5c0 commit 56bd1c9

7 files changed

Lines changed: 41 additions & 58 deletions

File tree

‎_docs/api/JsonLogic/JsonLogic.md‎

Lines changed: 0 additions & 56 deletions
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/JsonSchema.Net.DataGeneration/GenerationResult.md‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -21,5 +21,7 @@ Holds the result of an instance generation operation.
2121
| **ErrorMessage** | string | Gets the error message from the generation, if unsuccessful. |
2222
| **InnerResults** | IEnumerable\<GenerationResult\> | Gets the result objects from nested data generations. |
2323
| **IsSuccess** | bool | Gets whether the data generation was successful. |
24+
| **Location** | JsonPointer? | Gets the relative instance location at which this failure occurred, if known. |
2425
| **Result** | JsonNode | Gets the resulting JSON data, if successful. |
26+
| **SchemaLocations** | IReadOnlyList\<JsonPointer\> | Gets the related schema locations for this failure, if known. |
2527

‎_docs/api/JsonSchema.Net.DataGeneration/title.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,5 +4,5 @@ bookmark: JsonSchema.Net.DataGeneration
44
permalink: /api/JsonSchema.Net.DataGeneration/:title/
55
folder: true
66
order: "10.07"
7-
version: "3.0.1"
7+
version: "3.1.0"
88
---

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

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -48,6 +48,31 @@ true if the dividend is evenly divisible by the divisor; otherwise, false.
4848

4949
Both parameters must represent valid JSON numbers. If the divisor is zero or not a valid number,
5050

51+
### IsInteger(JsonElement value)
52+
53+
Determines whether the numeric value represented by the specified JSON element is a mathematical integer (i.e.
54+
has no fractional part), without converting to a .NET numeric type.
55+
56+
#### Declaration
57+
58+
```c#
59+
public static bool IsInteger(JsonElement value)
60+
```
61+
62+
| Parameter | Type | Description |
63+
|---|---|---|
64+
| value | JsonElement | A **System.Text.Json.JsonElement** whose **System.Text.Json.JsonElement.ValueKind** must be |
65+
66+
67+
#### Returns
68+
69+
<see langword="true" /> if the value has no fractional part; otherwise <see langword="false" />.
70+
71+
#### Remarks
72+
73+
Works directly from the JSON text representation so arbitrarily large integers are recognised correctly,
74+
avoiding overflow issues that arise when using `TryGetInt64`.
75+
5176
### NumberCompare(JsonElement a, JsonElement b)
5277

5378
Compares two JSON number values represented by **System.Text.Json.JsonElement** instances and determines their relative

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

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

‎_docs/release-notes/rn-json-schema-datageneration.md‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,14 @@ title: JsonSchema.Net.DataGeneration
44
icon: fas fa-tag
55
order: "09.07"
66
---
7+
# [3.1.0](https://github.com/gregsdennis/json-everything/pull/1015) {#release-schemadatagen-3.1.0}
8+
9+
- Replaced Fare with internal regex value generation to significantly improve regex support
10+
- Improved conditional support
11+
- Added `propertyNames` support
12+
- Increased test coverage to find and fix bugs
13+
- Added generation error reporting
14+
715
# [3.0.1](https://github.com/gregsdennis/json-everything/pull/1013) {#release-schemadatagen-3.0.1}
816

917
Updated nuget packages & EULA.

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

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,10 @@ title: JsonSchema.Net
44
icon: fas fa-tag
55
order: "09.01"
66
---
7+
# [9.1.4](https://github.com/gregsdennis/json-everything/pull/1015) {#release-schema-9.1.4}
8+
9+
Fixed an issue with `type` keyword and bigint values.
10+
711
# [9.1.3](https://github.com/gregsdennis/json-everything/pull/1013) {#release-schema-9.1.3}
812

913
Updated nuget packages & EULA.

0 commit comments

Comments
 (0)