Interface ResourceConfig

Fully resolved metadata for one resource, derived from the OpenAPI paths and schemas. This is the object every list/form/detail view is driven by.

interface ResourceConfig {
    displayFormat: string;
    displayName: string;
    fields: FieldConfig[];
    listColumns: string[];
    name: string;
    operations: {
        create: boolean;
        delete: boolean;
        get: boolean;
        list: boolean;
        patch: boolean;
        update: boolean;
    };
    orderedFields: FieldConfig[];
    pagination: | null
    | { defaultLimit: number; limitParam: string; offsetParam: string };
    parent?: { pathParam: string; resource: string };
    path: string;
    primaryKey: string;
    relationships: ResourceRelationship[];
    schemaName: string;
    streaming?: boolean;
    subResources?: string[];
    updateMethod: "put" | "patch";
}

Properties

displayFormat displayName fields listColumns name operations orderedFields pagination parent? path primaryKey relationships schemaName streaming? subResources? updateMethod

Properties

displayFormat

displayFormat: string

Template used to render a row/item title (x-display-format).

displayName

displayName: string

Human-friendly label used in navigation and titles.

fields

fields: FieldConfig[]

All fields, sorted by x-order then name.

listColumns

listColumns: string[]

Columns shown in the list view (x-list-columns).

name

name: string

Resource name (path segment), e.g. "expenses".

operations

operations: {
    create: boolean;
    delete: boolean;
    get: boolean;
    list: boolean;
    patch: boolean;
    update: boolean;
}

Which CRUD operations the spec exposes.

orderedFields

orderedFields: FieldConfig[]

Fields in fields restricted to those with a defined order.

pagination

pagination:
    | null
    | { defaultLimit: number; limitParam: string; offsetParam: string }

Pagination contract, or null when the collection is not paginated.

Optionalparent

parent?: { pathParam: string; resource: string }

Set when this is a sub-resource (nested under a parent resource).

path

path: string

Base API path for the collection, e.g. "/expenses".

primaryKey

primaryKey: string

Primary-key property name (x-primary-key).

relationships

relationships: ResourceRelationship[]

Foreign-key relationships for this resource.

schemaName

schemaName: string

Schema name used for display and lookups.

Optionalstreaming

streaming?: boolean

true when the collection is an x-sse event stream.

OptionalsubResources

subResources?: string[]

Names of nested sub-resources.

updateMethod

updateMethod: "put" | "patch"

Whether updates use PUT or PATCH.

Settings

Member Visibility

On This Page

Properties