Home DiscriminatorKeyword Class
DiscriminatorKeyword Class
Cancel

DiscriminatorKeyword Class

Namespace: Json.Schema.OpenApi

Inheritance: DiscriminatorKeyword 🡒 object

Implemented interfaces:

  • IJsonSchemaKeyword

Handles example.

Properties

NameTypeSummary
ExtensionsIReadOnlyDictionary<string, JsonNode>Allows extensions to the OpenAPI Schema. The field name MUST begin with x-, for example, x-internal-id. Field names beginning x-oai- and x-oas- are reserved for uses defined by the OpenAPI Initiative. The value can be null, a primitive, an array or an object.
MappingIReadOnlyDictionary<string, string>An object to hold mappings between payload values and schema names or references.
PropertyNamestringThe name of the property in the payload that will hold the discriminator value.

Constructors

DiscriminatorKeyword(string propertyName, IReadOnlyDictionary<string, string> mapping, IReadOnlyDictionary<string, JsonNode> extensions)

Creates a new Json.Schema.OpenApi.DiscriminatorKeyword.

Declaration

1
public DiscriminatorKeyword(string propertyName, IReadOnlyDictionary<string, string> mapping, IReadOnlyDictionary<string, JsonNode> extensions)
ParameterTypeDescription
propertyNamestringThe name of the property in the payload that will hold the discriminator value.
mappingIReadOnlyDictionary<string, string>An object to hold mappings between payload values and schema names or references.
extensionsIReadOnlyDictionary<string, JsonNode>Allows extensions to the OpenAPI Schema. The field name MUST begin with x-, for example, x-internal-id. Field names beginning x-oai- and x-oas- are reserved for uses defined by the OpenAPI Initiative. The value can be null, a primitive, an array or an object.

Methods

GetConstraint(SchemaConstraint schemaConstraint, IReadOnlyList<KeywordConstraint> localConstraints, EvaluationContext context)

Builds a constraint object for a keyword.

Declaration

1
public KeywordConstraint GetConstraint(SchemaConstraint schemaConstraint, IReadOnlyList<KeywordConstraint> localConstraints, EvaluationContext context)
ParameterTypeDescription
schemaConstraintSchemaConstraintThe Json.Schema.SchemaConstraint for the schema object that houses this keyword.
localConstraintsIReadOnlyList<KeywordConstraint>The set of other Json.Schema.KeywordConstraints that have been processed prior to this one. Will contain the constraints for keyword dependencies.
contextEvaluationContextThe Json.Schema.EvaluationContext.

Returns

A constraint object.

Contents