starflow/schema

Types

Represents an object property

pub type Property {
  Property(name: String, schema: Schema, required: Bool)
}

Constructors

  • Property(name: String, schema: Schema, required: Bool)

Represents a JSON Schema type

pub type Schema {
  Schema(json: json.Json)
}

Constructors

  • Schema(json: json.Json)

Functions

pub fn array(items: Schema) -> Schema

Creates an array type schema

pub fn boolean() -> Schema

Creates a boolean type schema

pub fn enum(values: List(String)) -> Schema

Creates an enum type schema

pub fn integer() -> Schema

Creates an integer type schema

pub fn number() -> Schema

Creates a number type schema

pub fn object(properties: List(Property)) -> Schema

Creates an object type schema

pub fn optional(name: String, schema: Schema) -> Property

Creates an optional property

pub fn required(name: String, schema: Schema) -> Property

Creates a required property

pub fn string() -> Schema

Creates a string type schema

pub fn string_with_format(format: String) -> Schema

Creates a string type schema with format

Search Document