Skip to content

Commit 39d48e9

Browse files
author
json-everything-ci
committed
regenerated api docs
1 parent b4bdf32 commit 39d48e9

File tree

71 files changed

+160
-138
lines changed

Some content is hidden

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

71 files changed

+160
-138
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/EvaluationOptions.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,7 @@ Allows configuration of the evaluation process.
2121
| **AddAnnotationForUnknownKeywords** | bool | Outputs an annotation that lists any unknown keywords. Can be useful for catching typos. |
2222
| **Culture** | CultureInfo | Gets or sets the culture for error messages. Overrides **Json.Schema.ErrorMessages.Culture**. |
2323
| **Default** | EvaluationOptions | The default settings. |
24+
| **FormatRegistry** | FormatRegistry | The local format registry. If a format is not found here, it will automatically check the global registry as well. |
2425
| **IgnoredAnnotations** | IEnumerable\<Type\> | Gets the set of keyword types from which annotations will be ignored. |
2526
| **OutputFormat** | OutputFormat | Specifies the output format. |
2627
| **PreserveDroppedAnnotations** | bool | If enabled, annotations that are dropped as a result of a failing subschema will be reported in a `droppedAnnotations` property in the output. |
Lines changed: 87 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,87 @@
1+
---
2+
layout: "page"
3+
title: "FormatRegistry Class"
4+
bookmark: "FormatRegistry"
5+
permalink: "/api/JsonSchema.Net/:title/"
6+
order: "10.01.049"
7+
---
8+
**Namespace:** Json.Schema
9+
10+
**Inheritance:**
11+
`FormatRegistry`
12+
🡒
13+
`object`
14+
15+
Represents a thread-safe registry for managing and retrieving format definitions within the application.
16+
17+
## Remarks
18+
19+
Use the FormatRegistry to register, unregister, and look up format definitions by key. The static
20+
Global property provides access to a shared, application-wide registry pre-populated with common formats. This class
21+
is designed for scenarios where centralized management of formats is required, and is safe for use across multiple
22+
23+
## Properties
24+
25+
| Name | Type | Summary |
26+
|---|---|---|
27+
| **Global** | FormatRegistry | Gets the global registry of formats available throughout the application. |
28+
29+
## Methods
30+
31+
### Get(string key)
32+
33+
Retrieves the format associated with the specified key, searching local and global collections.
34+
35+
#### Declaration
36+
37+
```c#
38+
public Format Get(string key)
39+
```
40+
41+
| Parameter | Type | Description |
42+
|---|---|---|
43+
| key | string | The key that identifies the format to retrieve. Cannot be null. |
44+
45+
46+
#### Returns
47+
48+
The format associated with the specified key if found; otherwise, a format representing an unknown key.
49+
50+
#### Remarks
51+
52+
If the format is not found in the local collection, the method searches the global collection
53+
54+
### Register(Format format)
55+
56+
Registers the specified format for later retrieval by its key.
57+
58+
#### Declaration
59+
60+
```c#
61+
public void Register(Format format)
62+
```
63+
64+
| Parameter | Type | Description |
65+
|---|---|---|
66+
| format | Format | The format to register. The format's key must be unique within the collection. |
67+
68+
69+
### Unregister(string name)
70+
71+
Unregisters the format associated with the specified name, removing it from the collection if it exists.
72+
73+
#### Declaration
74+
75+
```c#
76+
public void Unregister(string name)
77+
```
78+
79+
| Parameter | Type | Description |
80+
|---|---|---|
81+
| name | string | The name of the format to unregister. Cannot be null. |
82+
83+
84+
#### Remarks
85+
86+
If no format is registered with the specified name, this method has no effect. This method is
87+

_docs/api/JsonSchema.Net/Formats.md

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

_docs/api/JsonSchema.Net/IBaseDocument.md

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

_docs/api/JsonSchema.Net/IKeywordHandler.md

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

_docs/api/JsonSchema.Net/IdKeyword.md

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

0 commit comments

Comments
 (0)