IOpenApiSchemaWithUnevaluatedProperties Interface

Definition

Namespace:: Microsoft.OpenApi

Assembly:: Microsoft.OpenApi.dll

Package:: Microsoft.OpenApi v3.7.0

Source:: IOpenApiSchemaWithUnevaluatedProperties.cs

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Caution

Use IOpenApiSchemaMissingProperties instead.

Compatibility interface for UnevaluatedProperties schema support. This interface provides access to the UnevaluatedPropertiesSchema property, which represents the schema for unevaluated properties as defined in JSON Schema draft 2020-12.

NOTE: This is a temporary compatibility solution. In the next major version:

This interface will be merged into IOpenApiSchema
The UnevaluatedPropertiesSchema property will be renamed to UnevaluatedProperties
The current UnevaluatedProperties boolean property will be renamed to UnevaluatedPropertiesAllowed

[System.Obsolete("Use IOpenApiSchemaMissingProperties instead.")]
public interface IOpenApiSchemaWithUnevaluatedProperties

[<System.Obsolete("Use IOpenApiSchemaMissingProperties instead.")>]
type IOpenApiSchemaWithUnevaluatedProperties = interface

Public Interface IOpenApiSchemaWithUnevaluatedProperties

Derived: Microsoft.OpenApi.OpenApiSchema

Microsoft.OpenApi.OpenApiSchemaReference

Attributes: ObsoleteAttribute

Remarks

TODO: Remove this interface in the next major version and merge its content into IOpenApiSchema.

Properties

Name	Description
UnevaluatedPropertiesSchema	Follow JSON Schema definition: https://json-schema.org/draft/2020-12/json-schema-core#name-unevaluatedproperties This is a schema that unevaluated properties must validate against. When serialized, this takes precedence over the UnevaluatedProperties boolean property.

Applies to