Skip to content

Commit 8491818

Browse files
author
json-everything-ci
committed
regenerated api docs
1 parent fbe6fdc commit 8491818

File tree

6 files changed

+82
-2
lines changed

6 files changed

+82
-2
lines changed

_docs/api/JsonPointer.Net/JsonPointer.md

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@ Represents a JSON Pointer IAW RFC 6901.
3434
|---|---|---|
3535
| **Count** | int | Gets the number of segments in the pointer. |
3636
| **Item** | string | Gets a segment value by index. |
37-
| **Item** | JsonPointer | |
37+
| **Item** | JsonPointer | Creates a new pointer with the indicated segments. |
3838

3939
## Methods
4040

@@ -246,16 +246,22 @@ A new pointer.
246246

247247
### GetSubPointer(Range range)
248248

249+
Creates a new pointer with the indicated segments.
249250

250251
#### Declaration
251252

252253
```c#
253254
public JsonPointer GetSubPointer(Range range)
254255
```
255256

257+
| Parameter | Type | Description |
258+
|---|---|---|
259+
| range | Range | The segment range for the new pointer. |
260+
256261

257262
#### Returns
258263

264+
A new pointer.
259265

260266
### Parse(string source)
261267

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

Lines changed: 18 additions & 0 deletions
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

Lines changed: 20 additions & 0 deletions
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

Lines changed: 18 additions & 0 deletions
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

Lines changed: 18 additions & 0 deletions
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-yaml.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ title: Yaml2JsonNode
44
icon: fas fa-tag
55
order: "09.13"
66
---
7-
# 2.1.0 (No PR) {#release-yaml-2.1.0}
7+
# [2.1.0](https://github.com/gregsdennis/json-everything/commit/7c20af32520ade11cf09edd3b90fbdace9905b84) {#release-yaml-2.1.0}
88

99
Updated to latest YamlDotNet (v12.2.1 to v15.1.2).
1010

0 commit comments

Comments
 (0)