Interface: DefaultParameter
Extends
JsonSchema
Properties
$comment?
optional
$comment:string
Comment string.
Inherited from
JsonSchema.$comment
Source
$defs?
optional
$defs:object
Object definitions.
Inherited from
JsonSchema.$defs
Source
$ref?
optional
$ref:string
Reference to object definitions.
Inherited from
JsonSchema.$ref
Source
$schema?
optional
$schema:string
Dialect of JSON Schema.
Inherited from
JsonSchema.$schema
Source
default
default:
any
Default value for the game parameter.
Overrides
JsonSchema.default
Source
description?
optional
description:string
Description of the schema.
Inherited from
JsonSchema.description
Source
enum?
optional
enum:unknown
[]
Values the schema can have.
Inherited from
JsonSchema.enum
Source
format?
optional
format:string
Annotation to indicate the type of string value, e.g., "date-time" or "email".
Inherited from
JsonSchema.format
Source
items?
optional
items:JsonSchema
If the value is an array, the array items in JsonSchema.
Inherited from
JsonSchema.items
Source
properties?
optional
properties:object
If the value is an object, the properties in JsonSchema.
Index signature
[key
: string
]: JsonSchema
Inherited from
JsonSchema.properties
Source
required?
optional
required:string
[]
Required properties.
Inherited from
JsonSchema.required
Source
title?
optional
title:string
Intent of the schema.
Inherited from
JsonSchema.title
Source
type?
optional
type:JsonSchemaDataType
|JsonSchemaDataType
[]
Data type of the value or array of acceptable data types.
Inherited from
JsonSchema.type