kotlinx-schema-generator-json/kotlinx.schema.generator.json/RequiredFieldStrategy

RequiredFieldStrategy

enum RequiredFieldStrategy : Enum<RequiredFieldStrategy> (source)

Strategy for determining which parameters should be marked as required in the function schema.

This strategy ONLY affects which fields are included in the required array. Other OpenAI Strict Mode features (additionalProperties: false, strict: true flag) are always enabled.

Entries

ALL_REQUIRED

OpenAI Strict Mode (Default): All parameters are marked as required.

NON_NULLABLE_REQUIRED

Non-strict mode: Only non-nullable parameters are marked as required.

USE_DEFAULT_PRESENCE

Use the DefaultPresence from the introspector to determine required fields.

Properties

entries

val entries: EnumEntries<RequiredFieldStrategy>

Returns a representation of an immutable list of all enum entries, in the order they're declared.

name

val name: String

ordinal

val ordinal: Int

Functions

valueOf

fun valueOf(value: String): RequiredFieldStrategy

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

values

fun values(): Array<RequiredFieldStrategy>

Returns an array containing the constants of this enum type, in the order they're declared.

RequiredFieldStrategy

See also

Entries

Properties

Functions