Domain
Required: id, kind, name, display_name, description, owner, version
Optional: steward, status, tags, source, extensions
Specification
Schema browser
Supported object types are discovered from the repository's JSON Schema files at build time.
Entity
Required: id, kind, name, display_name, description, business_key, owner, version
Optional: steward, domain, status, classification, pii, canonical_table, relationships, synonyms, business_rules, quality, knowledge_graph, ai_context
Glossary Term
Required: id, kind, name, display_name, definition, owner, version
Optional: steward, domain, status, classification, synonyms, related_objects, tags, source, extensions
Metric
Required: id, kind, name, display_name, description, formula, grain, owner, version
Optional: steward, domain, status, classification, dimensions, filters, source, quality, synonyms, glossary_terms, ai_context, tags
Quality Expectation
Required: id, kind, name, display_name, description, target, expectation, severity, owner, version
Optional: steward, domain, status, tags, source, extensions
Relationship
Required: id, kind, name, display_name, description, from, to, relationship_type, version
Optional: owner, domain, status, tags, source, extensions
Semantic Object Common Fields
Required: id, kind, name, display_name, owner, version
Optional: description, steward, domain, status, classification, tags, source, extensions
Semantic Package
Required: id, kind, name, display_name, description, owner, version, spec_version
Optional: status, tags, lint, generators, dependencies, extensions
Complete YAML templates
id: domain-id
kind: domain
name: Domain Name
display_name: Domain Name
description: Describe the business area owned by this domain.
owner: Business Owner
steward: Data Steward
version: 0.1.0
status: draft
tags: []
extensions: {}
id: entity-id
kind: entity
name: Entity Name
display_name: Entity Name
description: Describe the business meaning of this entity.
business_key: entity_id
owner: Business Owner
steward: Data Steward
domain: Domain Name
version: 0.1.0
status: draft
classification: Internal
pii: false
canonical_table: gold.entity_table
relationships: []
synonyms: []
business_rules: []
quality: []
knowledge_graph: EntityName
ai_context: Explain how AI systems should interpret this entity.
extensions: {}
id: glossary-term-id
kind: glossary_term
name: Glossary Term
display_name: Glossary Term
definition: Define the business term in plain language.
owner: Business Owner
steward: Data Steward
domain: Domain Name
version: 0.1.0
status: draft
classification: Internal
synonyms: []
related_objects: []
extensions: {}
id: metric-id
kind: metric
name: Metric Name
display_name: Metric Name
description: Describe the business meaning and intended use of this metric.
formula: SUM(source_column)
grain: Entity Name
owner: Business Owner
steward: Data Steward
domain: Domain Name
version: 0.1.0
status: draft
classification: Internal
dimensions: []
filters: []
quality: []
synonyms: []
glossary_terms: []
ai_context: Explain how AI systems should interpret this metric.
extensions: {}
id: quality-expectation-id
kind: quality_expectation
name: Quality Expectation Name
display_name: Quality Expectation Name
description: Describe the data quality expectation in business terms.
target: Entity or Metric Name
expectation: completeness > 99%
severity: error
owner: Business Owner
steward: Data Steward
domain: Domain Name
version: 0.1.0
status: draft
extensions: {}
id: relationship-id
kind: relationship
name: Entity A to Entity B
display_name: Entity A to Entity B
description: Describe how the two semantic objects are related.
from: Entity A
to: Entity B
relationship_type: one_to_many
owner: Business Owner
domain: Domain Name
version: 0.1.0
status: draft
extensions: {}
id: package-id
kind: semantic_package
name: Package Name
display_name: Package Name
description: Describe the semantic package and its intended scope.
owner: Data Governance
version: 0.2.0
spec_version: 0.2.0
status: draft
tags: []
lint:
rules:
SAC-LINT-003: warning
SAC-LINT-004: warning
SAC-LINT-005: warning
generators:
markdown:
enabled: true
dependencies: []
extensions: {}