FLUID (Federated Layered Unified Interchange Definition) Specification

Type: object

A comprehensive, production-ready schema for FLUID data product contracts. This version adds stricter validation patterns for identifiers and other key fields to ensure contract integrity.

 No Additional Properties

root fluidVersion
Type: string

Version of the FLUID spec this contract adheres to.

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

"2.3.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 engine
Type: string

The transformation engine used. Provided examples cover common cloud services, but any string is valid.
Examples:

"bigquery"

"redshift-sql"

"athena-sql"

"snowflake-sql"

"dbt"

"spark-sql"

"spark-python"

"databricks-sql"

"databricks-python"

"emr-spark"

"glue-spark"

"dataflow-python"

"custom-python"

root build model
Type: string

A reference to the specific model or script (e.g., dbt model path, git URI to a SQL file).

root build config
Type: object

Engine-specific configuration key-value pairs.

Additional Properties of any type are allowed.

root build config additionalProperties
Type: object

root build trigger
Type: object

Defines how the build is initiated.

root build trigger oneOf item 0
Type: object

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

root build trigger oneOf item 0 cron
Type: string

A standard cron expression.

Must match regular expression: ^((?:\*|\d+(?:-\d+)?(?:,\d+(?:-\d+)?)*)(?:/\d+)?\s+){4,5}(?:\*|\d+(?:-\d+)?(?:,\d+(?:-\d+)?)*)(?:/\d+)?$
root build trigger oneOf item 1
Type: object

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

root build trigger oneOf item 1 eventType
Type: string
root build trigger oneOf item 2
Type: object

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

root build runtime
Type: object

root build runtime platform
Type: string

The runtime platform. Provided examples cover common cloud orchestrators, but any string is valid.
Examples:

"composer"

"mwaa"

"airflow"

"dbt-cloud"

"databricks"

"emr-serverless"

"glue-jobs"

"kubernetes-engine"

"cloud-run"

"aws-lambda"

root build runtime resources
Type: object

root build runtime resources cpu
Type: string

root build runtime resources memory
Type: string

root build retries
Type: object

root build retries count
Type: integer Default: 0

Value must be greater or equal to 0

root build retries delaySeconds
Type: integer Default: 0

Value must be greater or equal to 0

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

Must be one of:

  • "none"
  • "exponential"

root build notifications
Type: array
No Additional Items

Each item of this array must be:

root build notifications notification
Type: object

root build 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. Provided examples cover common cloud services, but any string is valid.
Examples:

"bigquery_table"

"bigquery_view"

"bigquery_materialized_view"

"gcs_delta_table"

"gcs_iceberg_table"

"gcs_parquet_files"

"pubsub_topic"

"redshift_table"

"redshift_view"

"redshift_materialized_view"

"s3_delta_table"

"s3_iceberg_table"

"s3_parquet_files"

"kinesis_stream"

"kafka_topic"

"snowflake_table"

"api_endpoint"

root exposes exposes items description
Type: string

root exposes exposes items location
Type: object

root exposes exposes items location format
Type: string

Examples:

"parquet"

"delta"

"iceberg"

"json"

"csv"

"avro"

root exposes exposes items location properties
Type: object

Technology-specific properties. E.g., for BigQuery: { 'project': '...', 'dataset': '...', 'table': '...' }. For S3: { 'bucket': '...', 'path': '...' }.

root exposes exposes items tags
Type: object

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

The modeling archetype of the port.

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 to
Type: string

The 'id' of the target port for the relationship.

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 type
Type: string

The physical data type.

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

root exposes exposes items schema schema items semantic
Type: string

Reference to an ontology term or glossary ID.

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

Semantic tags like 'primarykey', 'foreignkey', 'pii'.

 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

Declarative transformation logic that separates lineage from rules.

 No Additional Items

Each item of this array must be:

root exposes exposes items mappings mapping
Type: object

Defines the transformation for a single target column, explicitly separating source columns for lineage from the transformation rule.

root exposes exposes items mappings mappings items target
Type: string

The name of the target column in the output schema.

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

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

An array of input columns used, for automated lineage generation.

 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 mappings mappings items rule
Type: string

The transformation logic or function to compute the target column.

root exposes exposes items quality
Type: array

A list of quality rules specific to this port.

 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 rule
Type: string

The rule to be enforced (e.g., 'not_null', 'unique', or a SQL predicate).

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

A list of privacy treatments applied to columns in this port.

 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

Defines the Service Level Objectives for the entire data product.

root slo latencyMs
Type: integer

Maximum query latency in milliseconds.

Value must be greater or equal to 0

root slo freshnessMinutes
Type: integer

Maximum data latency in minutes.

Value must be greater or equal to 0

root slo availabilityPct
Type: number

Expected uptime percentage.

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 principal
Type: string

e.g., group:analysts, user:name@company.com, gcpserviceaccount:..., awsiamrole:...

Must match regular expression: ^(group|user|gcp_service_account|aws_iam_role):.+$

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 sla
Type: object

Defines the Service Level Objectives for the entire data product.

Same definition as slo

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"

Method of at-rest encryption. Examples provided for cloud KMS services.
Examples:

"AES256"

"GCP_CMEK"

"AWS_KMS"

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

Method of in-transit encryption.
Examples:

"TLS1.2+"

"mTLS"

root governance
Type: object

root governance rules
Type: array of object
No Additional Items

Each item of this array must be:

root governance rules rules items
Type: object

root governance rules rules items name
Type: string