Skip to content

Commit b6c09e4

Browse files
author
json-everything-ci
committed
regenerated api docs
1 parent 064de5a commit b6c09e4

File tree

7 files changed

+80
-17
lines changed

7 files changed

+80
-17
lines changed

_docs/api/JsonPointer.Net/JsonPointer.md

Lines changed: 0 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -78,22 +78,16 @@ A new pointer.
7878

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

81-
Concatenates additional segments onto the current pointer.
8281

8382
#### Declaration
8483

8584
```c#
8685
public JsonPointer Combine(ReadOnlySpan<PointerSegment> additionalSegments)
8786
```
8887

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

9489
#### Returns
9590

96-
A new pointer.
9791

9892
### Create(params PointerSegment[] segments)
9993

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

121115
### Create(ReadOnlySpan\<PointerSegment\> segments)
122116

123-
Creates a new JSON Pointer from a collection of segments.
124117

125118
#### Declaration
126119

127120
```c#
128121
public static JsonPointer Create(ReadOnlySpan<PointerSegment> segments)
129122
```
130123

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

136125
#### Returns
137126

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

144128
### Create(Expression\<Func\<T, object\>\> expression, PointerCreationOptions options)
145129

_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/api/JsonSchema.Net.Generation/title.md

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

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

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,11 @@ title: JsonSchema.Net.Generation
44
icon: fas fa-tag
55
order: "09.05"
66
---
7+
8+
# [5.0.3](https://github.com/json-everything/json-everything/pull/897) {#release-schemagen-5.0.3}
9+
10+
Fixed schema generation for types with property overrides using 'new' keyword
11+
712
# [5.0.2](https://github.com/json-everything/json-everything/pull/887) {#release-schemagen-5.0.2}
813

914
Rerelease of 5.0.1 with fixed package dependencies. Thanks to [@arturcic](https://github.com/arturcic) for reporting.

0 commit comments

Comments
 (0)