Skip to content

Commit a223d56

Browse files
author
json-everything-ci
committed
regenerated api docs
1 parent abefd41 commit a223d56

4 files changed

Lines changed: 90 additions & 1 deletion

File tree

_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/JsonSchema.Net/SchemaRegistry.md

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -28,6 +28,33 @@ The registry supports registering schemas with unique URIs and enables lookup by
2828

2929
## Methods
3030

31+
### CreateBundle(Uri rootUri, Uri bundleUri, BuildOptions options)
32+
33+
Creates a bundled JSON Schema document that includes the root schema and all referenced schemas as definitions.
34+
35+
#### Declaration
36+
37+
```c#
38+
public JsonSchema CreateBundle(Uri rootUri, Uri bundleUri, BuildOptions options)
39+
```
40+
41+
| Parameter | Type | Description |
42+
|---|---|---|
43+
| rootUri | Uri | The URI of the root JSON Schema to bundle. This schema and all schemas it references will be included in the |
44+
| bundleUri | Uri | The URI to assign as the $id of the resulting bundled schema document. |
45+
| options | BuildOptions | The options to use when building the bundled schema, such as validation or parsing settings. |
46+
47+
48+
#### Returns
49+
50+
A new JsonSchema instance representing the bundled schema document, or null if the root schema cannot be found.
51+
52+
#### Remarks
53+
54+
The bundled schema will contain all referenced schemas under the `$defs` property, allowing for
55+
self-contained schema validation. If any referenced schema cannot be resolved, a **Json.Schema.RefResolutionException**
56+
will be thrown.
57+
3158
### Get(Uri uri)
3259

3360
Gets a schema by URI ID and/or anchor.

_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.4"
7+
version: "9.1.5"
88
---

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

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,12 @@ title: JsonSchema.Net
44
icon: fas fa-tag
55
order: "09.01"
66
---
7+
# [9.1.5](https://github.com/gregsdennis/json-everything/pull/1028) {#release-schema-9.1.5}
8+
9+
Adds `SchemaRegistry.CreateBundle()`.
10+
11+
[#996](https://github.com/gregsdennis/json-everything/pull/996) - Fixes a validation error message for `pattern`. Thanks to [@anthonypuppo](https://github.com/anthonypuppo) for submitting the fix.
12+
713
# [9.1.4](https://github.com/gregsdennis/json-everything/pull/1015) {#release-schema-9.1.4}
814

915
Fixed an issue with `type` keyword and bigint values.

0 commit comments

Comments
 (0)