File tree 4 files changed +74
-0
lines changed
_docs/api/JsonSchema.Net.Generation.DataAnnotations
4 files changed +74
-0
lines changed Original file line number Diff line number Diff line change @@ -17,16 +17,34 @@ order: "10.06.000"
17
17
- IAttributeHandler\< AllowedValuesAttribute\>
18
18
- IAttributeHandler
19
19
20
+ Adds an ` enum ` keyword for the indicated values.
21
+
22
+ ## Remarks
23
+
24
+ For NativeAOT scenarios, only primitive JSON types are supported.
20
25
21
26
## Methods
22
27
23
28
### AddConstraints(SchemaGenerationContextBase context, Attribute attribute)
24
29
30
+ Processes the type and any attributes (present on the context), and adds
31
+ intents to the context.
25
32
26
33
#### Declaration
27
34
28
35
``` c#
29
36
public void AddConstraints (SchemaGenerationContextBase context , Attribute attribute )
30
37
```
31
38
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.
32
50
Original file line number Diff line number Diff line change @@ -19,4 +19,24 @@ order: "10.06.001"
19
19
- IAttributeHandler\< Base64StringAttribute\>
20
20
- IAttributeHandler
21
21
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
+
22
42
Original file line number Diff line number Diff line change @@ -17,16 +17,34 @@ order: "10.06.003"
17
17
- IAttributeHandler\< DeniedValuesAttribute\>
18
18
- IAttributeHandler
19
19
20
+ Adds a ` not: {enum} ` construct for the indicated values.
21
+
22
+ ## Remarks
23
+
24
+ For NativeAOT scenarios, only primitive JSON types are supported.
20
25
21
26
## Methods
22
27
23
28
### AddConstraints(SchemaGenerationContextBase context, Attribute attribute)
24
29
30
+ Processes the type and any attributes (present on the context), and adds
31
+ intents to the context.
25
32
26
33
#### Declaration
27
34
28
35
``` c#
29
36
public void AddConstraints (SchemaGenerationContextBase context , Attribute attribute )
30
37
```
31
38
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.
32
50
Original file line number Diff line number Diff line change @@ -17,16 +17,34 @@ order: "10.06.007"
17
17
- IAttributeHandler\< LengthAttribute\>
18
18
- IAttributeHandler
19
19
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.
20
25
21
26
## Methods
22
27
23
28
### AddConstraints(SchemaGenerationContextBase context, Attribute attribute)
24
29
30
+ Processes the type and any attributes (present on the context), and adds
31
+ intents to the context.
25
32
26
33
#### Declaration
27
34
28
35
``` c#
29
36
public void AddConstraints (SchemaGenerationContextBase context , Attribute attribute )
30
37
```
31
38
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.
32
50
You can’t perform that action at this time.
0 commit comments