Optional
deprecatedWhether the type is deprecated or not.
Optional
descriptionDetailed description of the schema.
Optional
exampleExample value.
Optional
examplesList of example values as key-value pairs.
Optional
nullableWhether to allow null
value or not.
Properties of the object.
The properties
means a list of key-value pairs of the object's
regular properties. The key is the name of the regular property,
and the value is the type schema info.
If you need additional properties that is represented by dynamic key, it is not possible to compose because the Gemini does not support it.
List of key values of the required properties.
The required
means a list of the key values of the required
properties. If some property key is not listed in the required
list, it means that property is optional. Otherwise some property key
exists in the required
list, it means that the property must be filled.
Below is an example of the properties and required
.
interface SomeObject {
id: string;
email: string;
name?: string;
}
As you can see, id
and email
properties are required,
so that they are listed in the required
list.
{
"type": "object",
"properties": {
"id": { "type": "string" },
"email": { "type": "string" },
"name": { "type": "string" }
},
"required": ["id", "email"]
}
Discriminator value of the type.
Object type schema info.