Interface AutoBeInterfaceSchemaPropertyCreate

Add a new property to a DTO schema.

Use when a database field or relation reference is missing from the schema.

interface AutoBeInterfaceSchemaPropertyCreate {
    key: string;
    reason: string;
    required: boolean;
    schema: AutoBeOpenApi.IJsonSchemaProperty;
    type: "create";
}

Index

Properties

key reason required schema type

Properties

key

key: string

Property key to add.

reason

reason: string

Reason for adding this property.

required

required: boolean

Whether property should be in required array.

schema

schema: AutoBeOpenApi.IJsonSchemaProperty

Schema definition for the new property.

type

type: "create"