Skip to content

Commit 4b9c799

Browse files
author
json-everything-ci
committed
regenerated api docs
1 parent cd218a0 commit 4b9c799

19 files changed

Lines changed: 155 additions & 12 deletions

‎_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: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -19,19 +19,45 @@ 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

2343
## Methods
2444

2545
### Apply(JsonSchemaBuilder builder)
2646

47+
Applies constraints for source generation.
2748

2849
#### Declaration
2950

3051
```c#
3152
public static JsonSchemaBuilder Apply(JsonSchemaBuilder builder)
3253
```
3354

55+
| Parameter | Type | Description |
56+
|---|---|---|
57+
| builder | JsonSchemaBuilder | The schema builder. |
58+
3459

3560
#### Returns
3661

62+
The builder for chaining.
3763

‎_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: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -17,29 +17,55 @@ 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

3351
### Apply(JsonSchemaBuilder builder, int minimumLength, int maximumLength)
3452

53+
Applies constraints for source generation.
3554

3655
#### Declaration
3756

3857
```c#
3958
public static JsonSchemaBuilder Apply(JsonSchemaBuilder builder, int minimumLength, int maximumLength)
4059
```
4160

61+
| Parameter | Type | Description |
62+
|---|---|---|
63+
| builder | JsonSchemaBuilder | The schema builder. |
64+
| minimumLength | int | The minimum length. |
65+
| maximumLength | int | The maximum length. |
66+
4267

4368
#### Returns
4469

70+
The builder for chaining.
4571

‎_docs/api/JsonSchema.Net.Generation/SchemaGeneratorConfiguration.md‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,8 @@ Provides additional configuration for the generator.
1919
| Name | Type | Summary |
2020
|---|---|---|
2121
| **Current** | SchemaGeneratorConfiguration | Thread-static storage of the current configuration. Only to be used for reading the configuration. Setting values on this object will be overwritten when starting generation. |
22+
| **Default** | SchemaGeneratorConfiguration | Gets the default configuration instance for the schema generator. |
23+
| **DefaultDialect** | Uri | Gets or sets the default dialect included in generated schemas. |
2224
| **ExternalReferences** | Dictionary\<Type, Uri\> | Allows mapping of types to external schema `$id`s. When encountering one of these types, a `$ref` keyword will be generated instead of a full schema. |
2325
| **Generators** | List\<ISchemaGenerator\> | A collection of generators in addition to the global set. |
2426
| **PropertyNameResolver** | PropertyNameResolver | Gets or sets the property name resolving method. Default is **Json.Schema.Generation.PropertyNameResolvers.AsDeclared**. |

‎_docs/api/JsonSchema.Net.Generation/SchemaHandlerAttribute.md‎

Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
1+
---
2+
layout: "page"
3+
title: "SchemaHandlerAttribute Class"
4+
bookmark: "SchemaHandlerAttribute"
5+
permalink: "/api/JsonSchema.Net.Generation/:title/"
6+
order: "10.055.082"
7+
---
8+
**Namespace:** Json.Schema.Generation
9+
10+
**Inheritance:**
11+
`SchemaHandlerAttribute`
12+
🡒
13+
`Attribute`
14+
🡒
15+
`object`
16+
17+
Registers a source generation schema handler for a target type.
18+
19+
## Properties
20+
21+
| Name | Type | Summary |
22+
|---|---|---|
23+
| **TargetType** | Type | The target type handled by the attributed handler. |
24+
| **TypeId** | object | |
25+
26+
## Constructors
27+
28+
### SchemaHandlerAttribute(Type targetType)
29+
30+
Creates a new **Json.Schema.Generation.SchemaHandlerAttribute** instance.
31+
32+
#### Declaration
33+
34+
```c#
35+
public SchemaHandlerAttribute(Type targetType)
36+
```
37+
38+
| Parameter | Type | Description |
39+
|---|---|---|
40+
| targetType | Type | The target type handled by the schema handler. |
41+
42+

‎_docs/api/JsonSchema.Net.Generation/ThenIntent.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ layout: "page"
33
title: "ThenIntent Class"
44
bookmark: "ThenIntent"
55
permalink: "/api/JsonSchema.Net.Generation/:title/"
6-
order: "10.055.082"
6+
order: "10.055.083"
77
---
88
**Namespace:** Json.Schema.Generation.Intents
99

‎_docs/api/JsonSchema.Net.Generation/TitleAttribute.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ layout: "page"
33
title: "TitleAttribute Class"
44
bookmark: "TitleAttribute"
55
permalink: "/api/JsonSchema.Net.Generation/:title/"
6-
order: "10.055.083"
6+
order: "10.055.084"
77
---
88
**Namespace:** Json.Schema.Generation
99

‎_docs/api/JsonSchema.Net.Generation/TitleIntent.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ layout: "page"
33
title: "TitleIntent Class"
44
bookmark: "TitleIntent"
55
permalink: "/api/JsonSchema.Net.Generation/:title/"
6-
order: "10.055.084"
6+
order: "10.055.085"
77
---
88
**Namespace:** Json.Schema.Generation.Intents
99

‎_docs/api/JsonSchema.Net.Generation/TypeExtensions.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ layout: "page"
33
title: "TypeExtensions Class"
44
bookmark: "TypeExtensions"
55
permalink: "/api/JsonSchema.Net.Generation/:title/"
6-
order: "10.055.085"
6+
order: "10.055.086"
77
---
88
**Namespace:** Json.Schema.Generation
99

0 commit comments

Comments
 (0)