Skip to main content

Type Alias: OpenApiDetailProps

OpenApiDetailProps = object

Defined in: detail/OpenApiDetail.tsx:43

Properties​

actions?​

optional actions?: React.ReactNode | ((args) => React.ReactNode)

Defined in: detail/OpenApiDetail.tsx:59

Content next to the heading, e.g. edit and delete buttons. A function receives the record and a refetch to reload it after a change.


fields?​

optional fields?: (string | OpenApiDetailField)[]

Defined in: detail/OpenApiDetail.tsx:49

Fields to show, in order. Omit to show every field of the record.


hideEmpty?​

optional hideEmpty?: boolean

Defined in: detail/OpenApiDetail.tsx:63

Hides fields whose value is empty. Defaults to false.


operationId​

operationId: string

Defined in: detail/OpenApiDetail.tsx:45

operationId of the GET operation that returns one record.


params?​

optional params?: OperationParams

Defined in: detail/OpenApiDetail.tsx:47

Path and query params, e.g. the id of the record.


title?​

optional title?: React.ReactNode | ((record) => React.ReactNode)

Defined in: detail/OpenApiDetail.tsx:54

Heading. Defaults to the record's name, title, label, email or id. Pass a function to build it from the record, or null to hide it.