Skip to main content

foundation-comms.metadata

Home > @genesislcap/foundation-comms > Metadata

Metadata type​

Metadata definition for a given resource.

Signature:

export type Metadata = {
    DEFINITIONS?: Record<string, any>;
    DESCRIPTION?: string;
    FIELD?: MetadataDetail[];
    REPLY?: ReplyDetail;
    REPLY_FIELD?: MetadataDetail[];
    REQUEST_FIELD?: MetadataDetail[];
    NAME?: string;
    TYPE?: string;
    INDEXES?: IndexDetail[];
    ERROR?: string;
    CRITERIA_ONLY_REQUEST?: boolean;
};

References: MetadataDetail, ReplyDetail, IndexDetail