JSONSchema Interface
Properties
| Name | Type | Description | |
|---|---|---|---|
| $comment | string | undefined | ||
| $id | string | undefined | ||
| $ref | string | undefined | ||
| $schema | string | undefined | ||
| additionalItems | boolean | JSONSchema | ||
| additionalProperties | boolean | JSONSchema | ||
| allOf | JSONSchema[] | undefined | ||
| allowComments | boolean | undefined | ||
| allowTrailingCommas | boolean | undefined | ||
| anyOf | JSONSchema[] | undefined | ||
| const | any | undefined | ||
| contains | JSONSchema | undefined | ||
| default | JSONSchemaType | undefined | ||
| defaultSnippets | JSONSchemaSnippet[] | undefined | ||
| definitions | JSONSchemaMap | undefined | ||
| dependencies | JSONSchemaMap | [prop: string]: string[] | ||
| deprecationMessage | string | undefined | ||
| description | string | undefined | ||
| doNotSuggest | boolean | undefined | ||
| else | JSONSchema | undefined | ||
| enum | JSONSchemaType[] | undefined | ||
| enumDescriptions | string[] | undefined | ||
| errorMessage | string | undefined | ||
| exclusiveMaximum | number | boolean | ||
| exclusiveMinimum | number | boolean | ||
| format | string | undefined | ||
| id | string | undefined | ||
| if | JSONSchema | undefined | ||
| items | JSONSchema | JSONSchema[] | ||
| markdownDeprecationMessage | string | undefined | ||
| markdownDescription | string | undefined | ||
| markdownEnumDescriptions | string[] | undefined | ||
| maximum | number | undefined | ||
| maxItems | number | undefined | ||
| maxLength | number | undefined | ||
| maxProperties | number | undefined | ||
| minimum | number | undefined | ||
| minItems | number | undefined | ||
| minLength | number | undefined | ||
| minProperties | number | undefined | ||
| multipleOf | number | undefined | ||
| not | JSONSchema | undefined | ||
| oneOf | JSONSchema[] | undefined | ||
| pattern | string | undefined | ||
| patternErrorMessage | string | undefined | ||
| patternProperties | JSONSchemaMap | undefined | ||
| properties | JSONSchemaMap | undefined | ||
| propertyNames | JSONSchema | undefined | ||
| required | string[] | undefined | ||
| suggestSortText | string | undefined | ||
| then | JSONSchema | undefined | ||
| title | string | undefined | ||
| type | JSONSchemaTypeName | JSONSchemaTypeName[] | ||
| uniqueItems | boolean | undefined |
Defined in
- core/bentley/src/JsonSchema.ts Line 18
Last Updated: 24 June, 2025
Found something wrong, missing, or unclear on this page? Raise an issue in our repo.