FLUID (Federated Layered Unified Interchange Definition) Specification

Type: object

A comprehensive, production-ready schema for FLUID data product contracts. Version 0.4.0 replaces the oneOf in build.transformation.properties with conditional validation to remove ambiguity, while keeping the rest of v0.3.0 verbatim.

 No Additional Properties

root fluidVersion
Type: string

Version of the FLUID spec this contract adheres to.

Must match regular expression: ^\d+\.\d+(\.\d+)?$
Example:

"0.4.0"

root kind
Type: string

The type of data product definition.
Examples:

"DataProduct"

"VirtualDataProduct"

"EgressFlow"

"IngestFlow"

"MLModelProduct"

"FeatureStoreProduct"

root id
Type: string

Globally-unique, versioned data product identifier. Should be machine-friendly.

Must match regular expression: ^[a-zA-Z0-9_.-]+$

Must be at least 1 characters long

root name
Type: string

Human-readable product name.

root description
Type: string

A brief, business-focused description of the product's purpose.

root domain
Type: string

The owning business domain (e.g., 'Marketing', 'Finance').

Must match regular expression: ^[a-zA-Z0-9_.-]+$

root metadata
Type: object

root metadata layer
Type: enum (of string)

The architectural layer of the data product.

Must be one of:

  • "Bronze"
  • "Silver"
  • "Gold"
  • "Platinum"

root metadata owner

The team or individual responsible for the data product.

root metadata owner oneOf item 0
Type: stringFormat: email

A contact email address for the owner.
root metadata owner oneOf item 1
Type: object

root metadata owner oneOf item 1 team
Type: string

root metadata owner oneOf item 1 email
Type: stringFormat: email

root metadata owner oneOf item 1 slack
Type: string

root metadata status
Type: enum (of string) Default: "Development"

Must be one of:

  • "Development"
  • "Published"
  • "Deprecated"

root metadata tags
Type: array of string

A list of arbitrary tags for categorization.

 No Additional Items

Each item of this array must be:

root metadata tags tags items
Type: string

root consumes
Type: array

An optional list of input data sources required to build the product.

 No Additional Items

Each item of this array must be:

root consumes consume
Type: object

root consumes consumes items id
Type: string

A local alias for the consumed data source.

Must match regular expression: ^[a-zA-Z0-9_.-]+$

root consumes consumes items ref
Type: string

A reference to another data product (e.g., URN).

root build
Type: object

Describes the logical transformation process and its operational details.

root build transformation

root build transformation allOf item 0
Type: object

If the conditions in the "If" tab are respected, then the conditions in the "Then" tab should be respected. Otherwise, the conditions in the "Else" tab should be respected.

root build transformation allOf item 0 if
Type: object

root build transformation allOf item 0 if pattern
Type: const
Specific value: "hybrid-reference"
root build transformation allOf item 0 then
Type: object

root build transformation allOf item 0 then properties
Type: object

root build transformation allOf item 0 then properties vars
Type: object

Additional Properties of any type are allowed.

root build transformation allOf item 0 then properties vars additionalProperties
Type: object
root build transformation allOf item 1
Type: object

If the conditions in the "If" tab are respected, then the conditions in the "Then" tab should be respected. Otherwise, the conditions in the "Else" tab should be respected.

root build transformation allOf item 1 if
Type: object

root build transformation allOf item 1 if pattern
Type: const
Specific value: "declarative"
root build transformation allOf item 1 then
Type: object

root build transformation allOf item 1 then properties
Type: object

root build transformation allOf item 1 then properties joins
Type: array
No Additional Items

Each item of this array must be:

root build transformation allOf item 1 then properties joins join
Type: object

root build transformation allOf item 1 then properties joins joins items type
Type: enum (of string)

Must be one of:

  • "inner"
  • "left"
  • "right"
  • "full"

root build transformation allOf item 1 then properties filters
Type: array of string
No Additional Items

Each item of this array must be:

root build transformation allOf item 1 then properties filters filters items
Type: string

root build transformation allOf item 1 then properties select
Type: array
No Additional Items

Each item of this array must be:

root build transformation allOf item 1 then properties select select
Type: object
root build transformation allOf item 2
Type: object

If the conditions in the "If" tab are respected, then the conditions in the "Then" tab should be respected. Otherwise, the conditions in the "Else" tab should be respected.

root build transformation allOf item 2 if
Type: object

root build transformation allOf item 2 if pattern
Type: const
Specific value: "embedded-logic"
root build transformation allOf item 2 then
Type: object

root build transformation allOf item 2 then properties
Type: object

root build transformation allOf item 2 then properties language
Type: enum (of string)

Must be one of:

  • "sql"
  • "flink_sql"
  • "pyspark"
  • "scala"
root build transformation allOf item 3
Type: object

If the conditions in the "If" tab are respected, then the conditions in the "Then" tab should be respected. Otherwise, the conditions in the "Else" tab should be respected.

root build transformation allOf item 3 if
Type: object

root build transformation allOf item 3 if pattern
Type: const
Specific value: "logical-mapping"
root build transformation allOf item 3 then
Type: object

root build transformation allOf item 3 then properties
Type: object

root build transformation allOf item 3 then properties sources
Type: array of string
No Additional Items

Each item of this array must be:

root build transformation allOf item 3 then properties sources sources items
Type: string

root build transformation allOf item 3 then properties steps
Type: array
No Additional Items

Each item of this array must be:

root build transformation allOf item 3 then properties steps step
Type: object

root build transformation allOf item 3 then properties steps steps items type
Type: enum (of string)

Must be one of:

  • "join"
  • "filter"
  • "project"
  • "aggregate"

root build transformation pattern
Type: enum (of string) Default: "hybrid-reference"

The transformation build pattern used.

Must be one of:

  • "declarative"
  • "hybrid-reference"
  • "embedded-logic"
  • "logical-mapping"

root build transformation engine
Type: string

The transformation engine used.

root build transformation properties
Type: object

Pattern-specific properties for the build transformation.

root build execution
Type: object

root build execution trigger
Type: object

Defines how the build is initiated.

root build execution trigger oneOf item 0
Type: object

root build execution trigger oneOf item 0 type
Type: const
Specific value: "schedule"

root build execution trigger oneOf item 0 cron
Type: string
root build execution trigger oneOf item 1
Type: object

root build execution trigger oneOf item 1 type
Type: const
Specific value: "event"

root build execution trigger oneOf item 2
Type: object

root build execution trigger oneOf item 2 type
Type: const
Specific value: "manual"

root build execution runtime
Type: object

root build execution runtime platform
Type: string

root build execution runtime resources
Type: object

root build execution runtime resources cpu
Type: string

root build execution retries
Type: object

root build execution retries count
Type: integer Default: 0

Value must be greater or equal to 0

root build execution retries delaySeconds
Type: integer Default: 0

Value must be greater or equal to 0

root build execution retries backoff
Type: enum (of string) Default: "none"

Must be one of:

  • "none"
  • "exponential"

root build execution notifications
Type: array
No Additional Items

Each item of this array must be:

root build execution notifications notification
Type: object

root build execution notifications notifications items channel
Type: enum (of string)

Must be one of:

  • "email"
  • "slack"
  • "pagerduty"
  • "webhook"

root exposes
Type: array

The public output interfaces (ports) of the data product.

Must contain a minimum of 1 items

No Additional Items

Each item of this array must be:

root exposes expose
Type: object

A single output port of the data product.

root exposes exposes items id
Type: string

The unique identifier for this output port.

Must match regular expression: ^[a-zA-Z0-9_.-]+$

root exposes exposes items type
Type: string

The physical type of the output.

root exposes exposes items description
Type: string

root exposes exposes items location
Type: object

root exposes exposes items location properties
Type: object

Technology-specific properties (e.g., dataset, table, bucket).

root exposes exposes items tags
Type: object

root exposes exposes items tags archetype
Type: enum (of string)

Must be one of:

  • "hub"
  • "satellite"
  • "link"
  • "view"
  • "table"

root exposes exposes items tags relationships
Type: array
No Additional Items

Each item of this array must be:

root exposes exposes items tags relationships relationship
Type: object

root exposes exposes items tags relationships relationships items cardinality
Type: enum (of string)

Must be one of:

  • "one-to-one"
  • "one-to-many"
  • "many-to-one"
  • "many-to-many"

root exposes exposes items schema
Type: array
No Additional Items

Each item of this array must be:

root exposes exposes items schema column
Type: object

root exposes exposes items schema schema items name
Type: string
Must match regular expression: ^[a-zA-Z0-9_]+$

root exposes exposes items schema schema items nullable
Type: boolean Default: true

root exposes exposes items schema schema items tags
Type: array of string
No Additional Items

Each item of this array must be:

root exposes exposes items schema schema items tags tags items
Type: string

root exposes exposes items mappings
Type: array

OPTIONAL. Column-level lineage and rules for governance. SHOULD be generated from build.transformation, not manually maintained.

 No Additional Items

Each item of this array must be:

root exposes exposes items mappings mapping
Type: object

root exposes exposes items mappings mappings items target
Type: string
Must match regular expression: ^[a-zA-Z0-9_]+$

root exposes exposes items mappings mappings items sources
Type: array of string
No Additional Items

Each item of this array must be:

root exposes exposes items mappings mappings items sources sources items
Type: string

root exposes exposes items quality
Type: array
No Additional Items

Each item of this array must be:

root exposes exposes items quality qualityRule
Type: object

root exposes exposes items quality quality items onFailure
Type: object

root exposes exposes items quality quality items onFailure action
Type: enum (of string)

Must be one of:

  • "reject_row"
  • "quarantine_row"
  • "fail_pipeline"
  • "alert"

root exposes exposes items privacy
Type: array
No Additional Items

Each item of this array must be:

root exposes exposes items privacy privacyRule
Type: object

root exposes exposes items privacy privacy items classification
Type: enum (of string)

Must be one of:

  • "PII"
  • "SPI"
  • "Confidential"

root exposes exposes items privacy privacy items columns
Type: array of string
No Additional Items

Each item of this array must be:

root exposes exposes items privacy privacy items columns columns items
Type: string

root exposes exposes items privacy privacy items treatment
Type: object

root exposes exposes items privacy privacy items treatment type
Type: enum (of string)

Must be one of:

  • "hashing"
  • "masking"
  • "encryption"
  • "tokenization"

root exposes exposes items semantics
Type: object

root exposes exposes items semantics ontology
Type: stringFormat: uri

root exposes exposes items semantics classifications
Type: object

Each additional property must conform to the following schema

root exposes exposes items semantics classifications additionalProperties
Type: string

root slo
Type: object

root slo latencyMs
Type: integer

Value must be greater or equal to 0

root slo freshnessMinutes
Type: integer

Value must be greater or equal to 0

root slo availabilityPct
Type: number

Value must be greater or equal to 0 and lesser or equal to 100

root accessPolicy
Type: object

root accessPolicy grants
Type: array
No Additional Items

Each item of this array must be:

root accessPolicy grants accessGrant
Type: object

root accessPolicy grants grants items permissions
Type: array of enum (of string)
No Additional Items

Each item of this array must be:

root accessPolicy grants grants items permissions permissions items
Type: enum (of string)

Must be one of:

  • "readData"
  • "readMetadata"
  • "manage"

root operations
Type: object

root operations lifecycle
Type: object

root operations lifecycle retentionPeriodDays
Type: integer

Value must be greater or equal to 0

root operations lifecycle deletionPolicy
Type: enum (of string)

Must be one of:

  • "hard-delete"
  • "soft-delete"
  • "anonymize"

root security
Type: object

root security encryptionAtRest
Type: string Default: "AES256"

root security encryptionInTransit
Type: string Default: "TLS1.2+"

root governance
Type: object

root governance lineage
Type: string

root governance regulatory
Type: array of enum (of string)
No Additional Items

Each item of this array must be:

root governance regulatory regulatory items
Type: enum (of string)

Must be one of:

  • "GDPR"
  • "CCPA"
  • "HIPAA"
  • "SOX"

root governance stewardship
Type: object

root governance stewardship steward
Type: string

root governance stewardship email
Type: stringFormat: email