Skip to main content
Using Deno in production at your company? Earn free Deno merch.
Give us feedback
Module

x/windmill/node_modules/@types/json-schema/index.d.ts>JSONSchema6

Windmill deno client (separated from the main repo because most of the code is auto-generated from the openapi and not worth committing)
Go to Latest
interface JSONSchema6
import { type JSONSchema6 } from "https://deno.land/x/windmill@v1.355.3/node_modules/@types/json-schema/index.d.ts";

Properties

optional
$id: string | undefined
optional
$ref: string | undefined
optional
$schema: JSONSchema6Version | undefined
optional
multipleOf: number | undefined

Must be strictly greater than 0. A numeric instance is valid only if division by this keyword's value results in an integer.

optional
maximum: number | undefined

Representing an inclusive upper limit for a numeric instance. This keyword validates only if the instance is less than or exactly equal to "maximum".

optional
exclusiveMaximum: number | undefined

Representing an exclusive upper limit for a numeric instance. This keyword validates only if the instance is strictly less than (not equal to) to "exclusiveMaximum".

optional
minimum: number | undefined

Representing an inclusive lower limit for a numeric instance. This keyword validates only if the instance is greater than or exactly equal to "minimum".

optional
exclusiveMinimum: number | undefined

Representing an exclusive lower limit for a numeric instance. This keyword validates only if the instance is strictly greater than (not equal to) to "exclusiveMinimum".

optional
maxLength: number | undefined

Must be a non-negative integer. A string instance is valid against this keyword if its length is less than, or equal to, the value of this keyword.

optional
minLength: number | undefined

Must be a non-negative integer. A string instance is valid against this keyword if its length is greater than, or equal to, the value of this keyword. Omitting this keyword has the same behavior as a value of 0.

optional
pattern: string | undefined

Should be a valid regular expression, according to the ECMA 262 regular expression dialect.

optional
items: JSONSchema6Definition | JSONSchema6Definition[] | undefined

This keyword determines how child instances validate for arrays, and does not directly validate the immediate instance itself. Omitting this keyword has the same behavior as an empty schema.

optional
additionalItems: JSONSchema6Definition | undefined

This keyword determines how child instances validate for arrays, and does not directly validate the immediate instance itself. If "items" is an array of schemas, validation succeeds if every instance element at a position greater than the size of "items" validates against "additionalItems". Otherwise, "additionalItems" MUST be ignored, as the "items" schema (possibly the default value of an empty schema) is applied to all elements. Omitting this keyword has the same behavior as an empty schema.

optional
maxItems: number | undefined

Must be a non-negative integer. An array instance is valid against "maxItems" if its size is less than, or equal to, the value of this keyword.

optional
minItems: number | undefined

Must be a non-negative integer. An array instance is valid against "maxItems" if its size is greater than, or equal to, the value of this keyword. Omitting this keyword has the same behavior as a value of 0.

optional
uniqueItems: boolean | undefined

If this keyword has boolean value false, the instance validates successfully. If it has boolean value true, the instance validates successfully if all of its elements are unique. Omitting this keyword has the same behavior as a value of false.

optional
contains: JSONSchema6Definition | undefined

An array instance is valid against "contains" if at least one of its elements is valid against the given schema.

optional
maxProperties: number | undefined

Must be a non-negative integer. An object instance is valid against "maxProperties" if its number of properties is less than, or equal to, the value of this keyword.

optional
minProperties: number | undefined

Must be a non-negative integer. An object instance is valid against "maxProperties" if its number of properties is greater than, or equal to, the value of this keyword. Omitting this keyword has the same behavior as a value of 0.

optional
required: string[] | undefined

Elements of this array must be unique. An object instance is valid against this keyword if every item in the array is the name of a property in the instance. Omitting this keyword has the same behavior as an empty array.

optional
properties: { [k: string]: JSONSchema6Definition; } | undefined

This keyword determines how child instances validate for objects, and does not directly validate the immediate instance itself. Validation succeeds if, for each name that appears in both the instance and as a name within this keyword's value, the child instance for that name successfully validates against the corresponding schema. Omitting this keyword has the same behavior as an empty object.

optional
patternProperties: { [k: string]: JSONSchema6Definition; } | undefined

This attribute is an object that defines the schema for a set of property names of an object instance. The name of each property of this attribute's object is a regular expression pattern in the ECMA 262, while the value is a schema. If the pattern matches the name of a property on the instance object, the value of the instance's property MUST be valid against the pattern name's schema value. Omitting this keyword has the same behavior as an empty object.

optional
additionalProperties: JSONSchema6Definition | undefined

This attribute defines a schema for all properties that are not explicitly defined in an object type definition. If specified, the value MUST be a schema or a boolean. If false is provided, no additional properties are allowed beyond the properties defined in the schema. The default value is an empty schema which allows any value for additional properties.

optional
dependencies: { [k: string]: JSONSchema6Definition | string[]; } | undefined

This keyword specifies rules that are evaluated if the instance is an object and contains a certain property. Each property specifies a dependency. If the dependency value is an array, each element in the array must be unique. Omitting this keyword has the same behavior as an empty object.

optional
propertyNames: JSONSchema6Definition | undefined

Takes a schema which validates the names of all properties rather than their values. Note the property name that the schema is testing will always be a string. Omitting this keyword has the same behavior as an empty schema.

optional
enum: JSONSchema6Type[] | undefined

This provides an enumeration of all possible values that are valid for the instance property. This MUST be an array, and each item in the array represents a possible value for the instance value. If this attribute is defined, the instance value MUST be one of the values in the array in order for the schema to be valid.

optional
const: JSONSchema6Type | undefined

More readable form of a one-element "enum"

optional
type: JSONSchema6TypeName | JSONSchema6TypeName[] | undefined

A single type, or a union of simple types

optional
allOf: JSONSchema6Definition[] | undefined
optional
anyOf: JSONSchema6Definition[] | undefined
optional
oneOf: JSONSchema6Definition[] | undefined
optional
not: JSONSchema6Definition | undefined
optional
definitions: { [k: string]: JSONSchema6Definition; } | undefined
optional
title: string | undefined

This attribute is a string that provides a short description of the instance property.

optional
description: string | undefined

This attribute is a string that provides a full description of the of purpose the instance property.

optional
default: JSONSchema6Type | undefined

This keyword can be used to supply a default JSON value associated with a particular schema. It is RECOMMENDED that a default value be valid against the associated schema.

optional
examples: JSONSchema6Type[] | undefined

Array of examples with no validation effect the value of "default" is usable as an example without repeating it under this keyword

optional
format: string | undefined