Skip to content

Commit abc0c3c

Browse files
gregsdennisgregsdennis
committed
Merge branch 'main' of github.com:gregsdennis/json-everything-docs
2 parents 7d48c4e + 49da8ca commit abc0c3c

File tree

68 files changed

+171
-135
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

68 files changed

+171
-135
lines changed

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

Lines changed: 0 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -17,34 +17,16 @@ 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.
2520

2621
## Methods
2722

2823
### AddConstraints(SchemaGenerationContextBase context, Attribute attribute)
2924

30-
Processes the type and any attributes (present on the context), and adds
31-
intents to the context.
3225

3326
#### Declaration
3427

3528
```c#
3629
public void AddConstraints(SchemaGenerationContextBase context, Attribute attribute)
3730
```
3831

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.
5032

‎_docs/api/JsonSchema.Net.Generation.DataAnnotations/Base64StringAttributeAttributeHandler.md

Lines changed: 0 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -19,24 +19,4 @@ 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-
4222

‎_docs/api/JsonSchema.Net.Generation.DataAnnotations/DeniedValuesAttributeHandler.md

Lines changed: 0 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -17,34 +17,16 @@ 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.
2520

2621
## Methods
2722

2823
### AddConstraints(SchemaGenerationContextBase context, Attribute attribute)
2924

30-
Processes the type and any attributes (present on the context), and adds
31-
intents to the context.
3225

3326
#### Declaration
3427

3528
```c#
3629
public void AddConstraints(SchemaGenerationContextBase context, Attribute attribute)
3730
```
3831

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.
5032

‎_docs/api/JsonSchema.Net.Generation.DataAnnotations/LengthAttributeHandler.md

Lines changed: 0 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -17,34 +17,16 @@ 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.
2520

2621
## Methods
2722

2823
### AddConstraints(SchemaGenerationContextBase context, Attribute attribute)
2924

30-
Processes the type and any attributes (present on the context), and adds
31-
intents to the context.
3225

3326
#### Declaration
3427

3528
```c#
3629
public void AddConstraints(SchemaGenerationContextBase context, Attribute attribute)
3730
```
3831

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.
5032

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

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

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

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

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

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

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

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

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

Lines changed: 46 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,46 @@
1+
---
2+
layout: "page"
3+
title: "IdAttribute Class"
4+
bookmark: "IdAttribute"
5+
permalink: "/api/JsonSchema.Net.Generation/:title/"
6+
order: "10.05.029"
7+
---
8+
**Namespace:** Json.Schema.Generation
9+
10+
**Inheritance:**
11+
`IdAttribute`
12+
🡒
13+
`Attribute`
14+
🡒
15+
`object`
16+
17+
**Implemented interfaces:**
18+
19+
- IAttributeHandler
20+
21+
Applies an `$id` keyword.
22+
23+
## Properties
24+
25+
| Name | Type | Summary |
26+
|---|---|---|
27+
| **TypeId** | object | |
28+
| **Uri** | Uri | The regular expression pattern. |
29+
30+
## Constructors
31+
32+
### IdAttribute(string value)
33+
34+
Creates a new **Json.Schema.Generation.IdAttribute** instance.
35+
36+
#### Declaration
37+
38+
```c#
39+
public IdAttribute(string value)
40+
```
41+
42+
| Parameter | Type | Description |
43+
|---|---|---|
44+
| value | string | The value. |
45+
46+

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

Lines changed: 56 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,56 @@
1+
---
2+
layout: "page"
3+
title: "IdIntent Class"
4+
bookmark: "IdIntent"
5+
permalink: "/api/JsonSchema.Net.Generation/:title/"
6+
order: "10.05.030"
7+
---
8+
**Namespace:** Json.Schema.Generation.Intents
9+
10+
**Inheritance:**
11+
`IdIntent`
12+
🡒
13+
`object`
14+
15+
**Implemented interfaces:**
16+
17+
- ISchemaKeywordIntent
18+
19+
Provides intent to create an `$id` keyword.
20+
21+
## Properties
22+
23+
| Name | Type | Summary |
24+
|---|---|---|
25+
| **Id** | Uri | The URI to use as the schema's ID. |
26+
27+
## Constructors
28+
29+
### IdIntent(Uri uri)
30+
31+
Creates a new **Json.Schema.Generation.Intents.IdIntent** instance.
32+
33+
#### Declaration
34+
35+
```c#
36+
public IdIntent(Uri uri)
37+
```
38+
39+
40+
## Methods
41+
42+
### Apply(JsonSchemaBuilder builder)
43+
44+
Applies the keyword to the **Json.Schema.JsonSchemaBuilder**.
45+
46+
#### Declaration
47+
48+
```c#
49+
public void Apply(JsonSchemaBuilder builder)
50+
```
51+
52+
| Parameter | Type | Description |
53+
|---|---|---|
54+
| builder | JsonSchemaBuilder | The builder. |
55+
56+

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

0 commit comments

Comments
 (0)