Skip to content

Commit

Permalink
regenerated api docs
Browse files Browse the repository at this point in the history
  • Loading branch information
json-everything-ci committed Jul 25, 2024
1 parent 86d5e45 commit 49da8ca
Show file tree
Hide file tree
Showing 6 changed files with 8 additions and 75 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -17,34 +17,16 @@ order: "10.06.000"
- IAttributeHandler\<AllowedValuesAttribute\>
- IAttributeHandler

Adds an `enum` keyword for the indicated values.

## Remarks

For NativeAOT scenarios, only primitive JSON types are supported.

## Methods

### AddConstraints(SchemaGenerationContextBase context, Attribute attribute)

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

#### Declaration

```c#
public void AddConstraints(SchemaGenerationContextBase context, Attribute attribute)
```

| Parameter | Type | Description |
|---|---|---|
| context | SchemaGenerationContextBase | The generation context. |
| attribute | Attribute | The attribute. |


#### Remarks

A common pattern is to implement **Json.Schema.Generation.IAttributeHandler** on the
attribute itself. In this case, the <paramref name="attribute" /> parameter
will be the same instance as the handler and can likely be ignored.

Original file line number Diff line number Diff line change
Expand Up @@ -19,24 +19,4 @@ order: "10.06.001"
- IAttributeHandler\<Base64StringAttribute\>
- IAttributeHandler

Adds a `format` keyword with `base64`.

## Remarks

By default, `format` is an annotation only. No validation will occur unless configured to do so.

The `base64` format is defined by the OpenAPI 3.1 specification.

## Constructors

### Base64StringAttributeAttributeHandler()

Creates a new **Json.Schema.Generation.DataAnnotations.Base64StringAttributeAttributeHandler**.

#### Declaration

```c#
public Base64StringAttributeAttributeHandler()
```


Original file line number Diff line number Diff line change
Expand Up @@ -17,34 +17,16 @@ order: "10.06.003"
- IAttributeHandler\<DeniedValuesAttribute\>
- IAttributeHandler

Adds a `not: {enum}` construct for the indicated values.

## Remarks

For NativeAOT scenarios, only primitive JSON types are supported.

## Methods

### AddConstraints(SchemaGenerationContextBase context, Attribute attribute)

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

#### Declaration

```c#
public void AddConstraints(SchemaGenerationContextBase context, Attribute attribute)
```

| Parameter | Type | Description |
|---|---|---|
| context | SchemaGenerationContextBase | The generation context. |
| attribute | Attribute | The attribute. |


#### Remarks

A common pattern is to implement **Json.Schema.Generation.IAttributeHandler** on the
attribute itself. In this case, the <paramref name="attribute" /> parameter
will be the same instance as the handler and can likely be ignored.

Original file line number Diff line number Diff line change
Expand Up @@ -17,34 +17,16 @@ order: "10.06.007"
- IAttributeHandler\<LengthAttribute\>
- IAttributeHandler

Adds `minLength` and `maxLength` keywords.

## Remarks

`minLength` will be not be added if the value is less than or equal to zero.

## Methods

### AddConstraints(SchemaGenerationContextBase context, Attribute attribute)

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

#### Declaration

```c#
public void AddConstraints(SchemaGenerationContextBase context, Attribute attribute)
```

| Parameter | Type | Description |
|---|---|---|
| context | SchemaGenerationContextBase | The generation context. |
| attribute | Attribute | The attribute. |


#### Remarks

A common pattern is to implement **Json.Schema.Generation.IAttributeHandler** on the
attribute itself. In this case, the <paramref name="attribute" /> parameter
will be the same instance as the handler and can likely be ignored.

2 changes: 1 addition & 1 deletion _docs/api/JsonSchema.Net.Generation/title.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,5 +4,5 @@ bookmark: JsonSchema.Net.Generation
permalink: /api/JsonSchema.Net.Generation/:title/
folder: true
order: "10.05"
version: "4.4.0"
version: "4.5.0"
---
7 changes: 7 additions & 0 deletions _docs/release-notes/rn-json-schema-generation.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,13 @@ title: JsonSchema.Net.Generation
icon: fas fa-tag
order: "09.05"
---
# [4.4.0](https://github.com/gregsdennis/json-everything/pull/772) {#release-schemagen-4.5.0}

[#768](https://github.com/gregsdennis/json-everything/issues/768) - Added two ways to allow external references. Thanks to [@luisjones](https://github.com/luisjones) for suggesting the idea.

- Added `[Id]` attribute
- Added `SchemaGenerationConfiguration.ExternalReferences`

# [4.4.0](https://github.com/gregsdennis/json-everything/pull/770) {#release-schemagen-4.4.0}

Updated to use _JsonSchema.Net_ v7.0.0, which contains breaking changes ([release notes](/rn-json-schema/#release-schema-7.0.0)).
Expand Down

0 comments on commit 49da8ca

Please sign in to comment.