JsonSchema

import type { JsonSchema } from "https://googleapis.deno.dev/v1/connectors:v2.ts";

JsonSchema representation of schema metadata

interface JsonSchema {

additionalDetails?: {

[key: string]: any;

};

default?: any;

description?: string;

enum?: any[];

exclusiveMaximum?: boolean;

exclusiveMinimum?: boolean;

format?: string;

items?: JsonSchema;

jdbcType?:

| "DATA_TYPE_UNSPECIFIED"

| "INT"

| "SMALLINT"

| "DOUBLE"

| "DATE"

| "DATETIME"

| "TIME"

| "STRING"

| "LONG"

| "BOOLEAN"

| "DECIMAL"

| "UUID"

| "BLOB"

| "BIT"

| "TINYINT"

| "INTEGER"

| "BIGINT"

| "FLOAT"

| "REAL"

| "NUMERIC"

| "CHAR"

| "VARCHAR"

| "LONGVARCHAR"

| "TIMESTAMP"

| "NCHAR"

| "NVARCHAR"

| "LONGNVARCHAR"

| "NULL"

| "OTHER"

| "JAVA_OBJECT"

| "DISTINCT"

| "STRUCT"

| "ARRAY"

| "CLOB"

| "REF"

| "DATALINK"

| "ROWID"

| "BINARY"

| "VARBINARY"

| "LONGVARBINARY"

| "NCLOB"

| "SQLXML"

| "REF_CURSOR"

| "TIME_WITH_TIMEZONE"

| "TIMESTAMP_WITH_TIMEZONE";

maximum?: any;

maxItems?: number;

maxLength?: number;

minimum?: any;

minItems?: number;

minLength?: number;

pattern?: string;

properties?: {

[key: string]: JsonSchema;

};

required?: string[];

type?: string[];

uniqueItems?: boolean;

}

§Properties

additionalDetails?: {

[key: string]: any;

}

[src]

Additional details apart from standard json schema fields, this gives flexibility to store metadata about the schema

default?: any

[src]

The default value of the field or object described by this schema.

description?: string

[src]

A description of this schema.

enum?: any[]

[src]

Possible values for an enumeration. This works in conjunction with type to represent types with a fixed set of legal values

exclusiveMaximum?: boolean

[src]

Whether the maximum number value is exclusive.

exclusiveMinimum?: boolean

[src]

Whether the minimum number value is exclusive.

format?: string

[src]

Format of the value as per https://json-schema.org/understanding-json-schema/reference/string.html#format

items?: JsonSchema

[src]

Schema that applies to array values, applicable only if this is of type array.

[src]

JDBC datatype of the field.

maximum?: any

[src]

Maximum value of the number field.

maxItems?: number

[src]

Maximum number of items in the array field.

maxLength?: number

[src]

Maximum length of the string field.

minimum?: any

[src]

Minimum value of the number field.

minItems?: number

[src]

Minimum number of items in the array field.

minLength?: number

[src]

Minimum length of the string field.

pattern?: string

[src]

Regex pattern of the string field. This is a string value that describes the regular expression that the string value should match.

properties?: {

[key: string]: JsonSchema;

}

[src]

The child schemas, applicable only if this is of type object. The key is the name of the property and the value is the json schema that describes that property

required?: string[]

[src]

Whether this property is required.

type?: string[]

[src]

JSON Schema Validation: A Vocabulary for Structural Validation of JSON

uniqueItems?: boolean

[src]

Whether the items in the array field are unique.