Interface AutoBeInterfaceSchemaPropertyUpdate

Replace an existing property's schema definition.

Use when property type, format, or structure is incorrect. For nullability-only changes, use nullish instead.

interface AutoBeInterfaceSchemaPropertyUpdate {
    key: string;
    newKey: string | null;
    reason: string;
    required: boolean;
    schema: AutoBeOpenApi.IJsonSchemaProperty;
    type: "update";
}

Properties

key: string

Current property key to update.

newKey: string | null

New property key after update.

reason: string

Reason for replacing this property's schema.

required: boolean

Whether property should be in required array.

New schema definition that replaces the existing one.

type: "update"