ChainGraph API Documentation / @badaitech/chaingraph-types / FlowMetadata

Interface: FlowMetadata

Defined in: packages/chaingraph-types/src/flow/types.ts:12

Flow metadata

Properties

canFork?

optional canFork: boolean

Defined in: packages/chaingraph-types/src/flow/types.ts:56

Whether the current user can fork this flow

---

createdAt

createdAt: Date

Defined in: packages/chaingraph-types/src/flow/types.ts:23

Creation timestamp

---

description?

optional description: string

Defined in: packages/chaingraph-types/src/flow/types.ts:20

Optional description

---

folderId?

optional folderId: string | null

Defined in: packages/chaingraph-types/src/flow/types.ts:38

Folder ID for tree organization (null = root level)

---

forkRule?

optional forkRule: Record<string, any>

Defined in: packages/chaingraph-types/src/flow/types.ts:50

Fork permission rule in JSONLogic format - defaults to false (not forkable)

---

id?

optional id: string

Defined in: packages/chaingraph-types/src/flow/types.ts:14

Unique identifier

---

isPublic?

optional isPublic: boolean

Defined in: packages/chaingraph-types/src/flow/types.ts:53

Whether the flow is publicly visible - defaults to false (private)

---

metadata?

optional metadata: Record<string, unknown>

Defined in: packages/chaingraph-types/src/flow/types.ts:47

Custom metadata

---

name

name: string

Defined in: packages/chaingraph-types/src/flow/types.ts:17

Display name

---

order?

optional order: number

Defined in: packages/chaingraph-types/src/flow/types.ts:41

Sort order within folder

---

ownerID?

optional ownerID: string

Defined in: packages/chaingraph-types/src/flow/types.ts:32

Owner ID

---

parentId?

optional parentId: string

Defined in: packages/chaingraph-types/src/flow/types.ts:35

Parent flow ID

---

schemaVersion?

optional schemaVersion: string

Defined in: packages/chaingraph-types/src/flow/types.ts:59

Schema version for the flow

---

tags?

optional tags: string[]

Defined in: packages/chaingraph-types/src/flow/types.ts:29

Tags for organization

---

updatedAt

updatedAt: Date

Defined in: packages/chaingraph-types/src/flow/types.ts:26

Last modified timestamp

---

version?

optional version: number

Defined in: packages/chaingraph-types/src/flow/types.ts:44

Version number