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

org.openapis.v3.SchemaGenerator1.0.0

Properties
Methods

module org.openapis.v3.SchemaGenerator

Enables the generation of a Schema from a Pkl module, class, or typealias.

Module URI:: package://pkg.pkl-lang.org/pkl-pantry/SchemaGenerator.pkl
Pkl version:: 0.25.0 or higher
Source code:: SchemaGenerator.pkl
Known subtypes:
Known usages:
All versions:: 1.0.0

Properties(show inherited)

link

hidden

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

hidden

converters: Mapping<Class, Schema>Source

Customize how the generator produces JSON Schema. This is useful if a Pkl type is expected to map to a (non-standard) JSON Schema type.

To use converters, a new instance of SchemaGenerator must be initialized.

Example:

import "package://pkg.pkl-lang.org/pkl-pantry/org.openapis.v3@1.0.0#/SchemaGenerator.pkl"

k8sGenerator = new SchemaGenerator {
  converters {
    [DataSize] {
      type = "string"
      description = "A Kubernetes data size representation. For instance, 5Mi"
      pattern = "^\d+(?:[EPTGMK]i?)?$"
    }
  }
}

Methods(show inherited)

link

function

getClass(): Class (pkl.base)Source

Returns the class of this.
link

function

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

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

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

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

function

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

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

toDynamic(): Dynamic (pkl.base)Source

Converts this object to a Dynamic object.
link

function

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

Converts this object to a Map.
link

function
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)
```
link

function
generate(value: Module|Class|TypeAlias): Schema Source

Given either a module, class, or typealias, generates the equivalent OpenAPI v3.0 Schema.
Example:
```
import "package://pkg.pkl-lang.org/pkl-pantry/org.openapis.v3@1.0.0#/SchemaGenerator.pkl"

class Person {
  /// The person's legal name.
  name: String?
}

personSchema = SchemaGenerator.generate(Person)
```
personSchema generates a schema that looks like so:
```
{
  "type": "object",
  "title": "Person",
  "properties": {
    "name": {
      "type": "string",
      "description": "The person's legal name.",
      "nullable": true
    }
  },
  "additionalProperties": false,
  "required": []
}
```
Known limitations:
- This generator cannot generate schemas that contain recursive descriptors, because a single Schema lacks the ability to reuse definitions.
- Type Constraints do not get encoded into the Schema. The only exceptions are well-known type constraints for numbers (for example, Int8 and UInt8).