Home XmlKeyword Class
XmlKeyword Class
Cancel

XmlKeyword Class

Namespace: Json.Schema.OpenApi

Inheritance: XmlKeyword 🡒 object

Implemented interfaces:

  • IJsonSchemaKeyword

Handles example.

Properties

NameTypeSummary
Attributebool?Declares whether the property definition translates to an attribute instead of an element. Default value is false.
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.
NamestringReplaces the name of the element/attribute used for the described schema property. When defined within items, it will affect the name of the individual XML elements within the list. When defined alongside type being array (outside the items), it will affect the wrapping element and only if wrapped is true. If wrapped is false, it will be ignored.
NamespaceUriThe URI of the namespace definition. This MUST be in the form of an absolute URI.
PrefixstringThe prefix to be used for the name.
Wrappedbool?MAY be used only for an array definition. Signifies whether the array is wrapped (for example, \<books\>\<book /\>\<book /\>\</books\>) or unwrapped (\<book /\>\<book /\>). Default value is false. The definition takes effect only when defined alongside type being array (outside the items).

Constructors

XmlKeyword(Uri namespace, string name, string prefix, bool? attribute, bool? wrapped, IReadOnlyDictionary<string, JsonNode> extensions)

Creates a new Json.Schema.OpenApi.ExternalDocsKeyword.

Declaration

1
public XmlKeyword(Uri namespace, string name, string prefix, bool? attribute, bool? wrapped, IReadOnlyDictionary<string, JsonNode> extensions)
ParameterTypeDescription
namespaceUriThe URI of the namespace definition. This MUST be in the form of an absolute URI.
namestringReplaces the name of the element/attribute used for the described schema property. When defined within items, it will affect the name of the individual XML elements within the list. When defined alongside type being array (outside the items), it will affect the wrapping element and
prefixstringThe prefix to be used for the name.
attributebool?Declares whether the property definition translates to an attribute instead of an
wrappedbool?MAY be used only for an array definition. Signifies whether the array is wrapped (for example, \<books\>\<book /\>\<book /\>\</books\>) or unwrapped (\<book /\>\<book /\>). Default value is false. The definition takes effect only when defined alongside type
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