Packages > pkg.pkl-lang.org/pkl-pantry/org.openapis.v3 > org.openapis.v3.Schema

PropertySchema2.1.0

Properties
Methods

class PropertySchema extends Schema

Property schemas are Schemas that optionally include XML metadata.

Known subtypes:
Known usages:: Schema
All versions:: 2.1.3, 2.1.2, 2.1.1, 2.1.0, 2.0.0, 1.0.0

Properties(show inherited)

link

hidden

Module.output: ModuleOutput (pkl.base)Source

The output of this module.

Defaults to all module properties rendered as either Pcf or the format specified on the command line.
link

Schema.type: ("string"|"number"|"integer"|"boolean"|"object"|"array")? (org.openapis.v3.Schema)Source

The basic type of the value represented by this schema.

If this property is not defined, the value may be of any type.

link

An additional descriptor for the value represented by this schema.

OAS uses several known formats to define in fine detail the data type being used.

However, to support documentation needs, the format property is an open string-valued property, and can have any value. Formats such as "email", "uuid", and so on, may be used even though undefined by this specification. Types that are not accompanied by a format property follow the type definition in the JSON Schema. Tools that do not recognize a specific format may default to the type alone, as if the format is not specified.

The formats defined by the OAS are:

Common Name	`type`	`format`	Comments
integer	`integer`	`int32`	signed 32 bits
long	`integer`	`int64`	signed 64 bits
float	`number`	`float`
double	`number`	`double`
string	`string`
byte	`string`	`byte`	base64 encoded characters
binary	`string`	`binary`	any sequence of octets
boolean	`boolean`
date	`string`	`date`	As defined by `full-date` - RFC3339
dateTime	`string`	`date-time`	As defined by `date-time` - RFC3339
password	`string`	`password`	A hint to UIs to obscure input.

https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md#dataTypeFormat

link

Schema.title: String? (org.openapis.v3.Schema)Source

A short descriptor of this schema.

https://json-schema.org/understanding-json-schema/reference/generic.html#annotations
link

Schema.description: String? (org.openapis.v3.Schema)Source

A long descriptor of this schema. Maybe written in Markdown.

https://json-schema.org/understanding-json-schema/reference/generic.html#annotations
link

Schema.default: Any? (org.openapis.v3.Schema)Source

Specifies a default value.

This value is not used to fill in missing values during the validation process. Non-validation tools such as documentation generators or form generators may use this value to give hints to users about how to use a value. However, default is typically used to express that if a value is missing, then the value is semantically the same as if the value was present with the default value. The value of default should validate against the schema in which it resides, but that isn't required.

https://json-schema.org/understanding-json-schema/reference/generic.html#annotations
link

Schema.enum: Listing<Any>(!isEmpty && isDistinct)? (org.openapis.v3.Schema)Source

Restricts the value specified by this schema to a fixed set of values.

It must be an array with at least one element, where each element is unique.

You can use enum even without a type, to accept values of different types.

Elements in the array might be of any type, including null. https://json-schema.org/understanding-json-schema/reference/generic.html#enumerated-values
link

Schema.multipleOf: Number(type is ("number"|"integer") && isPositive)? (org.openapis.v3.Schema)Source

Restricts to a number that is a multiple of this value.

It may be set to any positive number.

https://json-schema.org/understanding-json-schema/reference/numeric.html#multiples
link

Schema.minimum: Number(type is ("number"|"integer"))? (org.openapis.v3.Schema)Source

Represent a number that is greater or equal to this value.

https://json-schema.org/understanding-json-schema/reference/numeric.html#range
link

Schema.exclusiveMinimum: Number(type is ("number"|"integer"))? (org.openapis.v3.Schema)Source

Represent a number that is greater than this value.

https://json-schema.org/understanding-json-schema/reference/numeric.html#range
link

Schema.maximum: Number(type is ("number"|"integer"))? (org.openapis.v3.Schema)Source

Represent a number that is less than or equal to this value.

https://json-schema.org/understanding-json-schema/reference/numeric.html#range
link

Schema.exclusiveMaximum: Number(type is ("number"|"integer"))? (org.openapis.v3.Schema)Source

Represent a number that is less than this value.

https://json-schema.org/understanding-json-schema/reference/numeric.html#range
link

Schema.pattern: String(isRegex && type == "string")? (org.openapis.v3.Schema)Source

Represent a string that adheres to a regex pattern.

The regular expression must conform to ECMA 262.

https://json-schema.org/understanding-json-schema/reference/string.html#regular-expressions
link

Schema.minLength: UInt(type == "string")? (org.openapis.v3.Schema)Source

Represent a string that has a minimum length.

https://json-schema.org/understanding-json-schema/reference/string.html#length
link

Schema.maxLength: UInt(type == "string")? (org.openapis.v3.Schema)Source

Represent a string that has a maximum length.

https://json-schema.org/understanding-json-schema/reference/string.html#length
link

Schema.items: (Schema|Reference)(type == "array")? (org.openapis.v3.Schema)Source

Represent that each item in an array must conform to the specified schema.

If the type is array, items must be specified.
link

Schema.minItems: UInt(type == "array")? (org.openapis.v3.Schema)Source

Represent an array that has a minumum length.

https://json-schema.org/understanding-json-schema/reference/array.html#length
link

Schema.maxItems: UInt(type == "array")? (org.openapis.v3.Schema)Source

Represent an array that has a maximum length.

https://json-schema.org/understanding-json-schema/reference/array.html#length
link

Schema.uniqueItems: Boolean? (org.openapis.v3.Schema)Source

Represent an array where each item is unique.

https://json-schema.org/understanding-json-schema/reference/array.html#uniqueness
link

Schema.minProperties: UInt(type == "object")? (org.openapis.v3.Schema)Source

Represent an object that must have at minimum a certain number of properties.

https://json-schema.org/understanding-json-schema/reference/object.html#size
link

Schema.maxProperties: UInt(type == "object")? (org.openapis.v3.Schema)Source

Represent an object that must have at maximum a certain number of properties.
link

Schema.properties: Mapping<String, (PropertySchema|Reference)>(type == "object")? (org.openapis.v3.Schema)Source

Represent an object that have properties that conform to a certain schema.

https://json-schema.org/understanding-json-schema/reference/object.html#properties
link

Schema.additionalProperties: (PropertySchema|Boolean|Reference)(type == "object")? (org.openapis.v3.Schema)Source

Represent an object that has additional properties.

The value of additionalProperties is a schema that will be used to validate any properties in the instance that are not matched by properties. Setting the additionalProperties schema to false means no additional properties will be allowed.

https://json-schema.org/understanding-json-schema/reference/object.html#additional-properties
link

Schema.required: Listing<String>(type == "object", isDistinct)? (org.openapis.v3.Schema)Source

Represent an object that has certain properties defined on it.

By default, no properties are required.

https://json-schema.org/understanding-json-schema/reference/object.html#required-properties
link

Schema.oneOf: Listing<(Schema|Reference)>(length > 0)? (org.openapis.v3.Schema)Source

Represent a value that must match against exactly one of the subschemas.

https://json-schema.org/understanding-json-schema/reference/combining.html#oneof
link

Schema.anyOf: Listing<(Schema|Reference)>(length > 0)? (org.openapis.v3.Schema)Source

Represent a value that must match at least one of the subschemas.

https://json-schema.org/understanding-json-schema/reference/combining.html#anyof
link

Schema.allOf: Listing<(Schema|Reference)>(length > 0)? (org.openapis.v3.Schema)Source

Represent a value that must match all of the subschemas.

https://json-schema.org/understanding-json-schema/reference/combining.html#allof
link

Schema.not: (Schema|Reference)? (org.openapis.v3.Schema)Source

Represent a value that must not match the given schema.

https://json-schema.org/understanding-json-schema/reference/combining.html#not
link

Schema.nullable: Boolean? (org.openapis.v3.Schema)Source

Represent that the value may optionally be null.

Default value is false.

https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md#fixed-fields-20
link

Schema.discriminator: Discriminator? (org.openapis.v3.Schema)Source

Helps inform of alternative schemas.

When request bodies or response payloads may be one of a number of different schemas, a discriminator object can be used to aid in serialization, deserialization, and validation. The discriminator is a specific object in a schema which is used to inform the consumer of the specification of an alternative schema based on the value associated with it.

When using the discriminator, inline schemas will not be considered.

https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md#discriminator-object
link

Schema.readOnly: Boolean? (org.openapis.v3.Schema)Source

Declares the property as "read only".

Relevant only for Schema properties definitions. This means that it may be sent as part of a response but should not be sent as part of the request. If the property is marked as readOnly and is in the required list, required only effects the response. A property may not be marked as both readOnly and writeOnly.

Default value is false.

https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md#fixed-fields-20
link

Schema.writeOnly: Boolean(implies(readOnly != true))? (org.openapis.v3.Schema)Source

Declares the property as "write only".

This is relevant only for Schema properties definitions. Therefore, it it may be sent as part of a response but should not be sent as part If the property is marked as writeOnly being true and is in the required list, the required will take effect on the request only. A property may not be marked as both readOnly and writeOnly being true.

Default value is false.

https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md#fixed-fields-20
link

Schema.externalDocs: ExternalDocumentation? (org.openapis.v3.Schema)Source

Additional external documentation for this schema.
link

Schema.deprecated: Boolean? (org.openapis.v3.Schema)Source

Indicates that this property is deprecated.

Default value is false.

https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md#fixed-fields-20
link

Schema.example: Any? (org.openapis.v3.Schema)Source

A free-form property to include an example of an instance for this schema.

To represent examples that cannot be naturally represented in JSON or YAML, a string value can be used to contain the example with escaping where necessary.
link

hidden

Schema.renderers: Mapping<String, ValueRenderer> (org.openapis.v3.Schema)Source
link

xml: Xml?Source

Adds additional metadata to describe the XML representation of this property.

This may be used only on properties schemas. It has no effect on root schemas.

Methods(show inherited)

link

function

Any.getClass(): Class (pkl.base)Source

Returns the class of this.
link

function

Any.toString(): String (pkl.base)Source

Returns a string representation of this.

This method is used to convert the values of string interpolation expressions to strings.
link

function

Any.ifNonNull<Result>(transform: (NonNull) -> Result): Result? (pkl.base)Source

Returns this |> transform if this is non-null, and null otherwise.

This method is the complement of the ?? operator and the equivalent of an Option type's map and flatMap methods.
link

function

Typed.hasProperty(name: String): Boolean (pkl.base)Source

Tells if this object has a property with the given name.
link

function

Typed.getProperty(name: String): unknown (pkl.base)Source

Returns the value of the property with the given name.

Throws if a property with this name does not exist.
link

function

Typed.getPropertyOrNull(name: String): unknown? (pkl.base)Source

Returns the value of the property with the given name.

Returns null if a property with this name does not exist.
link

function

Typed.toDynamic(): Dynamic (pkl.base)Source

Converts this object to a Dynamic object.
link

function

Typed.toMap(): Map<String, unknown> (pkl.base)Source

Converts this object to a Map.
link

function
Module.relativePathTo(other: Module): List<String> (pkl.base)Source

Returns the relative, descendent directory path between this module and other.
Throws if no such path exists.

For example, if module mod1 has path /dir1/mod1.pkl, and module mod2 has path /dir1/dir2/dir3/mod2.pkl, then mod1.relativePathTo(mod2) will return List("dir2", "dir3").

A common use case is to compute the directory path between a template located at the root of a hierarchy (say rootModule.pkl) and the currently evaluated module (accessible via the module keyword):
```
import "rootModule.pkl" // self-import
path = rootModule.relativePathTo(module)
```