Skip to content

Commit 2c33327

Browse files
author
json-everything-ci
committed
regenerated api docs
1 parent 4c35c5d commit 2c33327

File tree

72 files changed

+187
-70
lines changed

Some content is hidden

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

72 files changed

+187
-70
lines changed

‎_docs/api/JsonPointer.Net/JsonPointer.md

Lines changed: 23 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@ Represents a JSON Pointer IAW RFC 6901.
3434
|---|---|---|
3535
| **Count** | int | Gets the number of segments in the pointer. |
3636
| **Item** | string | Gets a segment value by index. |
37-
| **Item** | JsonPointer | |
37+
| **Item** | JsonPointer | Creates a new pointer with the indicated segments. |
3838

3939
## Methods
4040

@@ -78,16 +78,22 @@ A new pointer.
7878

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

81+
Concatenates additional segments onto the current pointer.
8182

8283
#### Declaration
8384

8485
```c#
8586
public JsonPointer Combine(ReadOnlySpan<PointerSegment> additionalSegments)
8687
```
8788

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

8994
#### Returns
9095

96+
A new pointer.
9197

9298
### Create(params PointerSegment[] segments)
9399

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

115121
### Create(ReadOnlySpan\<PointerSegment\> segments)
116122

123+
Creates a new JSON Pointer from a collection of segments.
117124

118125
#### Declaration
119126

120127
```c#
121128
public static JsonPointer Create(ReadOnlySpan<PointerSegment> segments)
122129
```
123130

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

125136
#### Returns
126137

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

128144
### Create(Expression\<Func\<T, object\>\> expression, PointerCreationOptions options)
129145

@@ -272,16 +288,22 @@ A new pointer.
272288

273289
### GetSubPointer(Range range)
274290

291+
Creates a new pointer with the indicated segments.
275292

276293
#### Declaration
277294

278295
```c#
279296
public JsonPointer GetSubPointer(Range range)
280297
```
281298

299+
| Parameter | Type | Description |
300+
|---|---|---|
301+
| range | Range | The segment range for the new pointer. |
302+
282303

283304
#### Returns
284305

306+
A new pointer.
285307

286308
### Parse(ReadOnlySpan\<char\> source)
287309

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

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
---
2+
layout: "page"
3+
title: "GenerateJsonSchemaAttribute Class"
4+
bookmark: "GenerateJsonSchemaAttribute"
5+
permalink: "/api/JsonSchema.Net.Generation/:title/"
6+
order: "10.05.025"
7+
---
8+
**Namespace:** Json.Schema.Generation.Serialization
9+
10+
**Inheritance:**
11+
`GenerateJsonSchemaAttribute`
12+
🡒
13+
`Attribute`
14+
🡒
15+
`object`
16+
17+
Apply to a type to generate a schema for validation during deserialization
18+
by **Json.Schema.Generation.Serialization.GenerativeValidatingJsonConverter**.
19+
20+
## Properties
21+
22+
| Name | Type | Summary |
23+
|---|---|---|
24+
| **TypeId** | object | |
25+

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

Lines changed: 54 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,54 @@
1+
---
2+
layout: "page"
3+
title: "GenerativeValidatingJsonConverter Class"
4+
bookmark: "GenerativeValidatingJsonConverter"
5+
permalink: "/api/JsonSchema.Net.Generation/:title/"
6+
order: "10.05.026"
7+
---
8+
**Namespace:** Json.Schema.Generation.Serialization
9+
10+
**Inheritance:**
11+
`GenerativeValidatingJsonConverter`
12+
🡒
13+
`ValidatingJsonConverter`
14+
🡒
15+
`JsonConverterFactory`
16+
🡒
17+
`JsonConverter`
18+
🡒
19+
`object`
20+
21+
Extends **Json.Schema.Serialization.ValidatingJsonConverter** to also allow for
22+
schema generation using **Json.Schema.Generation.Serialization.GenerateJsonSchemaAttribute**.
23+
24+
## Properties
25+
26+
| Name | Type | Summary |
27+
|---|---|---|
28+
| **GeneratorConfiguration** | SchemaGeneratorConfiguration | Provides options for the generator. |
29+
| **Options** | EvaluationOptions | |
30+
| **OutputFormat** | OutputFormat? | |
31+
| **RequireFormatValidation** | bool? | |
32+
| **Type** | Type | |
33+
34+
## Methods
35+
36+
### CanConvert(Type typeToConvert)
37+
38+
When overridden in a derived class, determines whether the converter instance can convert the specified object type.
39+
40+
#### Declaration
41+
42+
```c#
43+
public override bool CanConvert(Type typeToConvert)
44+
```
45+
46+
| Parameter | Type | Description |
47+
|---|---|---|
48+
| typeToConvert | Type | The type of the object to check whether it can be converted by this converter instance. |
49+
50+
51+
#### Returns
52+
53+
<see langword="true" /> if the instance can convert the specified object type; otherwise, <see langword="false" />.
54+

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

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

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

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

‎_docs/api/JsonSchema.Net.Generation/IAttributeHandler`1.md

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

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ layout: "page"
33
title: "INestableAttribute Interface"
44
bookmark: "INestableAttribute"
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/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.036"
6+
order: "10.05.038"
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.037"
6+
order: "10.05.039"
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.038"
6+
order: "10.05.040"
77
---
88
**Namespace:** Json.Schema.Generation
99

0 commit comments

Comments
 (0)