Skip to content

Commit de8bd87

Browse files
author
json-everything-ci
committed
regenerated api docs
1 parent 203a22c commit de8bd87

File tree

7 files changed

+85
-7
lines changed

7 files changed

+85
-7
lines changed

_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/JsonSchemaExtensions.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -116,7 +116,7 @@ Gets the schemas in `allOf` if the keyword exists.
116116
#### Declaration
117117

118118
```c#
119-
public static IReadOnlyCollection<JsonSchema> GetAllOf(this JsonSchema schema)
119+
public static IReadOnlyList<JsonSchema> GetAllOf(this JsonSchema schema)
120120
```
121121

122122

@@ -146,7 +146,7 @@ Gets the schemas in `anyOf` if the keyword exists.
146146
#### Declaration
147147

148148
```c#
149-
public static IReadOnlyCollection<JsonSchema> GetAnyOf(this JsonSchema schema)
149+
public static IReadOnlyList<JsonSchema> GetAnyOf(this JsonSchema schema)
150150
```
151151

152152

@@ -431,7 +431,7 @@ Gets the values in `examples` if the keyword exists.
431431
#### Declaration
432432

433433
```c#
434-
public static IReadOnlyCollection<JsonNode> GetExamples(this JsonSchema schema)
434+
public static IReadOnlyList<JsonNode> GetExamples(this JsonSchema schema)
435435
```
436436

437437

@@ -536,7 +536,7 @@ Gets the schemas in `items` if the keyword exists and is an array of schemas.
536536
#### Declaration
537537

538538
```c#
539-
public static IReadOnlyCollection<JsonSchema> GetItemsArrayForm(this JsonSchema schema)
539+
public static IReadOnlyList<JsonSchema> GetItemsArrayForm(this JsonSchema schema)
540540
```
541541

542542

@@ -746,7 +746,7 @@ Gets the schemas in `oneOf` if the keyword exists.
746746
#### Declaration
747747

748748
```c#
749-
public static IReadOnlyCollection<JsonSchema> GetOneOf(this JsonSchema schema)
749+
public static IReadOnlyList<JsonSchema> GetOneOf(this JsonSchema schema)
750750
```
751751

752752

@@ -791,7 +791,7 @@ Gets the schemas in `prefixItems` if the keyword exists.
791791
#### Declaration
792792

793793
```c#
794-
public static IReadOnlyCollection<JsonSchema> GetPrefixItems(this JsonSchema schema)
794+
public static IReadOnlyList<JsonSchema> GetPrefixItems(this JsonSchema schema)
795795
```
796796

797797

_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: "6.0.7"
7+
version: "6.1.0"
88
---

_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+
# [6.1.0](https://github.com/gregsdennis/json-everything/pull/709) {#release-schema-6.1.0}
8+
9+
[#704](https://github.com/gregsdennis/json-everything/issues/704) - Several builder extension return types expanded from `IReadOnlyCollection<T>` to `IReadOnlyList<T>`. Thanks to [@SGStino](https://github.com/SGStino) for identifying and implementing this.
10+
711
# [6.0.7](https://github.com/gregsdennis/json-everything/pull/698) {#release-schema-6.0.7}
812

913
[#697](https://github.com/gregsdennis/json-everything/issues/697) - `allOf`, `anyOf`, `oneOf`, and `prefixItems` all require at least one subschema, but deserialization of these keywords didn't enforce this. Fix will throw `ArgumentException` when attempting to deserialize empty subschema sets. Thanks to [@Era-cell](https://github.com/Era-cell) for reporting this.

0 commit comments

Comments
 (0)