Skip to content

Commit 2d5aa32

Browse files
committed
Updated references to JsonIgnore - applies to enum members
1 parent aa1c7b6 commit 2d5aa32

File tree

2 files changed

+3
-3
lines changed

2 files changed

+3
-3
lines changed

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ Indicates that the property should be excluded from generation.
2222

2323
This attribute functions exactly the same as the **System.Text.Json.Serialization.JsonIgnoreAttribute**. It
2424
is included separately to support the case where the model should be serialized with
25-
a property but schema generation should ignore it.
25+
a property or an enum member but schema generation should ignore it.
2626

2727
## Properties
2828

_docs/schema/schemagen/schema-generation.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -70,7 +70,7 @@ All of these and more are supplied via a set of attributes that can be applied t
7070

7171
\* The `[Obsolete]` attribute is `System.Obsolete`. All of the others have been defined within this library. `System.ComponentModel.DataAnnotations` support is currently [in discussion](https://github.com/gregsdennis/json-everything/issues/143).
7272

73-
\*\* The `[JsonExclude]` attribute functions equivalently to `[JsonIgnore]` (see below). It is included to allow generation to skip a property while allowing serialization to consider it.
73+
\*\* The `[JsonExclude]` attribute functions equivalently to `[JsonIgnore]` (see below). It is included to allow generation to skip a property or an enum member while allowing serialization to consider it.
7474

7575
\*\*\* Even though the `const` and `default` keywords in JSON Schema can accept any JSON value, because they are attributes, `[Const]` and `[Default]` can only accept values which are compile-time constants.
7676

@@ -119,7 +119,7 @@ The generator also supports these .Net-defined attributes:
119119

120120
- `JsonPropertyName` - supports custom property naming (more on naming below)
121121
- `JsonNumberHandling`\* - supports allowing numeric values in strings or only as numbers as well as allowing the `NaN`, `Infinity`, and `-Infinity` values.
122-
- `JsonIgnore`\* - ignores a property
122+
- `JsonIgnore`\* - ignores a property or an enum member
123123

124124
\* These attributes were introduced with .Net 5. The .Net Standard 2.0 version of the library also provides a definition for them.
125125

0 commit comments

Comments
 (0)