Schema

io.cequence.openaiscala.gemini.domain.Schema

case class Schema(`type`: SchemaType, format: Option[String], description: Option[String], nullable: Option[Boolean], enum: Option[Seq[String]], maxItems: Option[String], minItems: Option[String], properties: Option[Map[String, Schema]], required: Option[Seq[String]], propertyOrdering: Option[Seq[String]], items: Option[Schema])

The Schema object allows the definition of input and output data types. These types can be objects, but also primitives and arrays. Represents a select subset of an OpenAPI 3.0 schema object.

Attributes

`type`: Required. Data type.
description: Optional. A brief description of the parameter. This could contain examples of use. Parameter description may be formatted as Markdown.
enum: Optional. Possible values of the element of Type.STRING with enum format. For example we can define an Enum Direction as : {type:STRING, format:enum, enum:["EAST", NORTH", "SOUTH", "WEST"]}
format: Optional. The format of the data. This is used only for primitive datatypes. Supported formats: for NUMBER type: float, double for INTEGER type: int32, int64 for STRING type: enum
items: Optional. Schema of the elements of Type.ARRAY.
maxItems: Optional. Maximum number of the elements for Type.ARRAY.
minItems: Optional. Minimum number of the elements for Type.ARRAY.
nullable: Optional. Indicates if the value may be null.
properties: Optional. Properties of Type.OBJECT. An object containing a list of "key": value pairs.
propertyOrdering: Optional. The order of the properties. Not a standard field in open api spec. Used to determine the order of the properties in the response.
required: Optional. Required properties of Type.OBJECT.
Graph
Supertypes: trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any

Members list

Concise view

Value members

Inherited methods

Attributes

Inherited from:: Product

Attributes

Inherited from:: Product

Generated with