Home ExternalDocsKeyword Class
ExternalDocsKeyword Class
Cancel

ExternalDocsKeyword Class

Namespace: Json.Schema.OpenApi

Inheritance: ExternalDocsKeyword 🡒 object

Implemented interfaces:

  • IJsonSchemaKeyword

Handles example.

Properties

NameTypeSummary
DescriptionstringA description of the target documentation. CommonMark syntax MAY be used for rich text representation.
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.
UrlUriThe URL for the target documentation. This MUST be in the form of a URL.

Constructors

ExternalDocsKeyword(Uri url, string description, IReadOnlyDictionary<string, JsonNode> extensions)

Creates a new Json.Schema.OpenApi.ExternalDocsKeyword.

Declaration

1
public ExternalDocsKeyword(Uri url, string description, IReadOnlyDictionary<string, JsonNode> extensions)
ParameterTypeDescription
urlUriThe URL for the target documentation. This MUST be in the form of a URL.
descriptionstringA description of the target documentation. CommonMark syntax MAY be used for rich text representation.
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