Project: /docs/reference/js/_project.yaml Book: /docs/reference/_book.yaml page_type: reference

{% comment %} DO NOT EDIT THIS FILE! This is generated by the JS SDK team, and any local changes will be overwritten. Changes should be made in the source code at https://github.com/firebase/firebase-js-sdk {% endcomment %}

SchemaShared interface

Basic Schema properties shared across several Schema-related types.

Signature:

typescript

export interface SchemaShared<T>

Properties

Property	Type	Description
anyOf	T[]	An array of Schema<!-- -->. The generated data must be valid against any of the schemas listed in this array. This allows specifying multiple possible structures or types for a single field.
description	string	Optional. The description of the property.
enum	string[]	Optional. The enum of the property.
example	unknown	Optional. The example of the property.
format	string	Optional. The format of the property. When using the Gemini Developer API (GoogleAIBackend<!-- -->), this must be either <code>'enum'</code> or <code>'date-time'</code>, otherwise requests will fail.
items	T	Optional. The items of the property.
maximum	number	The maximum value of a numeric type.
maxItems	number	The maximum number of items (elements) in a schema of SchemaType <code>array</code>.
minimum	number	The minimum value of a numeric type.
minItems	number	The minimum number of items (elements) in a schema of SchemaType <code>array</code>.
nullable	boolean	Optional. Whether the property is nullable.
properties	{ [k: string]: T; }	Optional. Map of <code>Schema</code> objects.
propertyOrdering	string[]	A hint suggesting the order in which the keys should appear in the generated JSON string.
title	string	The title of the property. This helps document the schema's purpose but does not typically constrain the generated value. It can subtly guide the model by clarifying the intent of a field.

SchemaShared.anyOf

An array of Schema. The generated data must be valid against any of the schemas listed in this array. This allows specifying multiple possible structures or types for a single field.

Signature:

typescript

anyOf?: T[];

SchemaShared.description

Optional. The description of the property.

Signature:

typescript

description?: string;

SchemaShared.enum

Optional. The enum of the property.

Signature:

typescript

enum?: string[];

SchemaShared.example

Optional. The example of the property.

Signature:

typescript

example?: unknown;

SchemaShared.format

Optional. The format of the property. When using the Gemini Developer API (GoogleAIBackend), this must be either 'enum' or 'date-time', otherwise requests will fail.

Signature:

typescript

format?: string;

SchemaShared.items

Optional. The items of the property.

Signature:

typescript

items?: T;

SchemaShared.maximum

The maximum value of a numeric type.

Signature:

typescript

maximum?: number;

SchemaShared.maxItems

The maximum number of items (elements) in a schema of SchemaType array.

Signature:

typescript

maxItems?: number;

SchemaShared.minimum

The minimum value of a numeric type.

Signature:

typescript

minimum?: number;

SchemaShared.minItems

The minimum number of items (elements) in a schema of SchemaType array.

Signature:

typescript

minItems?: number;

SchemaShared.nullable

Optional. Whether the property is nullable.

Signature:

typescript

nullable?: boolean;

SchemaShared.properties

Optional. Map of Schema objects.

Signature:

typescript

properties?: {
        [k: string]: T;
    };

SchemaShared.propertyOrdering

A hint suggesting the order in which the keys should appear in the generated JSON string.

Signature:

typescript

propertyOrdering?: string[];

SchemaShared.title

The title of the property. This helps document the schema's purpose but does not typically constrain the generated value. It can subtly guide the model by clarifying the intent of a field.

Signature:

typescript

title?: string;