Home ExampleKeyword Class
ExampleKeyword Class
Cancel

ExampleKeyword Class

Namespace: Json.Schema.OpenApi

Inheritance: ExampleKeyword 🡒 object

Implemented interfaces:

  • IJsonSchemaKeyword

Handles example.

Properties

NameTypeSummary
ValueJsonNodeThe example value.

Constructors

ExampleKeyword(JsonNode value)

Creates a new Json.Schema.OpenApi.ExampleKeyword.

Declaration

1
public ExampleKeyword(JsonNode value)
ParameterTypeDescription
valueJsonNodeThe example value.

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