Merge branch 'michaelusa/ontology-terminal-immutable' into 'main'

feat(ontology): add mutable and terminal_values property annotations

See merge request gitlab-org/orbit/knowledge-graph!1619

Author: Michael Usachenko

config/ontology/nodes/ci/deployment.yaml

@@ -21,36 +21,42 @@ properties:
     type: int64
     source: id
     nullable: false
+    mutable: false
     description: "Unique ID."
 
   iid:
     type: int64
     source: iid
     nullable: false
+    mutable: false
     description: "Project-scoped deployment number."
 
   project_id:
     type: int64
     source: project_id
     nullable: false
+    mutable: false
     description: "Owning project ID."
 
   ref:
     type: string
     source: ref
     nullable: false
+    mutable: false
     description: "Git ref (branch or tag) deployed."
 
   tag:
     type: boolean
     source: tag
     nullable: false
+    mutable: false
     description: "Whether the ref is a tag."
 
   sha:
     type: string
     source: sha
     nullable: false
+    mutable: false
     description: "Deployed commit SHA."
 
   status:
@@ -66,18 +72,21 @@ properties:
       4: canceled
       5: skipped
       6: blocked
+    terminal_values: [success, failed, canceled, skipped]
 
   deployable_type:
     type: string
     source: deployable_type
     nullable: false
+    mutable: false
     description: "Polymorphic type (typically CommitStatus, the STI base class for Ci::Build)."
     selectivity: low
 
   deployable_id:
     type: int64
     source: deployable_id
     nullable: true
+    mutable: false
     description: "Deployable ID."
 
   on_stop:
@@ -96,6 +105,7 @@ properties:
     type: timestamp
     source: created_at
     nullable: true
+    mutable: false
     description: "Creation timestamp."
 
   finished_at:
@@ -114,12 +124,14 @@ properties:
     type: int64
     source: environment_id
     nullable: false
+    mutable: false
     description: "Target environment ID."
 
   user_id:
     type: int64
     source: user_id
     nullable: true
+    mutable: false
     description: "Deploying user ID."
 
   traversal_path:

config/ontology/nodes/ci/environment.yaml

@@ -21,12 +21,14 @@ properties:
     type: int64
     source: id
     nullable: false
+    mutable: false
     description: "Unique ID."
 
   project_id:
     type: int64
     source: project_id
     nullable: false
+    mutable: false
     description: "Owning project ID."
 
   name:
@@ -126,6 +128,7 @@ properties:
     type: timestamp
     source: created_at
     nullable: true
+    mutable: false
     description: "Creation timestamp."
 
   updated_at:
@@ -138,6 +141,7 @@ properties:
     type: int64
     source: merge_request_id
     nullable: true
+    mutable: false
     description: "MR that created this review environment."
 
   traversal_path:

config/ontology/nodes/ci/job.yaml

@@ -21,12 +21,14 @@ properties:
     type: int64
     source: id
     nullable: false
+    mutable: false
     description: "Unique ID."
 
   name:
     type: string
     source: name
     nullable: false
+    mutable: false
     description: "Job name from .gitlab-ci.yml."
 
   status:
@@ -49,17 +51,20 @@ properties:
       10: waiting_for_resource
       11: waiting_for_callback
       12: canceling
+    terminal_values: [success, failed, canceled, skipped]
 
   ref:
     type: string
     source: ref
     nullable: false
+    mutable: false
     description: "Branch or tag name."
 
   tag:
     type: boolean
     source: tag
     nullable: true
+    mutable: false
     description: "Whether running on a git tag."
 
   allow_failure:
@@ -84,6 +89,7 @@ properties:
     type: enum
     source: when
     nullable: false
+    mutable: false
     description: "Run condition."
     enum_type: string
     values:
@@ -156,6 +162,7 @@ properties:
     type: timestamp
     source: created_at
     nullable: true
+    mutable: false
     description: "Creation timestamp."
 
   started_at:
@@ -180,6 +187,7 @@ properties:
     type: string
     source: type
     nullable: false
+    mutable: false
     description: "STI class: Ci::Build, Ci::Bridge, or GenericCommitStatus."
     selectivity: low
 
@@ -216,6 +224,7 @@ properties:
     type: enum
     source: scheduling_type
     nullable: false
+    mutable: false
     description: "Scheduling mode: stage or DAG."
     values:
       0: stage
@@ -225,30 +234,35 @@ properties:
     type: int64
     source: project_id
     nullable: false
+    mutable: false
     description: "Owning project ID."
 
   user_id:
     type: int64
     source: user_id
     nullable: true
+    mutable: false
     description: "Triggering user ID."
 
   upstream_pipeline_id:
     type: int64
     source: upstream_pipeline_id
     nullable: true
+    mutable: false
     description: "Upstream pipeline ID for bridge jobs."
 
   stage_id:
     type: int64
     source: stage_id
     nullable: true
+    mutable: false
     description: "Containing stage ID."
 
   pipeline_id:
     type: int64
     source: commit_id
     nullable: true
+    mutable: false
     description: "Containing pipeline ID. Source column is commit_id (legacy Rails naming)."
 
   auto_canceled_by_id:

config/ontology/nodes/ci/pipeline.yaml

@@ -21,24 +21,28 @@ properties:
     type: int64
     source: id
     nullable: false
+    mutable: false
     description: "Unique ID."
 
   iid:
     type: int64
     source: iid
     nullable: true
+    mutable: false
     description: "Project-scoped pipeline number."
 
   sha:
     type: string
     source: sha
     nullable: false
+    mutable: false
     description: "Commit SHA the pipeline runs against."
 
   ref:
     type: string
     source: ref
     nullable: false
+    mutable: false
     description: "Branch or tag name."
 
   status:
@@ -61,11 +65,13 @@ properties:
       10: waiting_for_resource
       11: waiting_for_callback
       12: canceling
+    terminal_values: [success, failed, canceled, skipped]
 
   source:
     type: enum
     source: source
     nullable: false
+    mutable: false
     description: "Trigger source."
     values:
       0: unknown
@@ -93,6 +99,7 @@ properties:
     type: boolean
     source: tag
     nullable: false
+    mutable: false
     description: "Whether running on a git tag."
 
   duration:
@@ -125,6 +132,7 @@ properties:
     type: timestamp
     source: created_at
     nullable: true
+    mutable: false
     description: "Creation timestamp."
 
   started_at:
@@ -143,6 +151,7 @@ properties:
     type: timestamp
     source: committed_at
     nullable: true
+    mutable: false
     description: "Commit timestamp."
 
   updated_at:
@@ -155,6 +164,7 @@ properties:
     type: string
     source: before_sha
     nullable: false
+    mutable: false
     description: "Previous commit SHA before the triggering push."
 
   yaml_errors:
@@ -173,18 +183,21 @@ properties:
     type: int64
     source: project_id
     nullable: false
+    mutable: false
     description: "Owning project ID."
 
   user_id:
     type: int64
     source: user_id
     nullable: true
+    mutable: false
     description: "Triggering user ID."
 
   merge_request_id:
     type: int64
     source: merge_request_id
     nullable: true
+    mutable: false
     description: "Triggering MR ID."
 
   auto_canceled_by_id:

config/ontology/nodes/ci/runner.yaml

@@ -22,12 +22,14 @@ properties:
     type: int64
     source: id
     nullable: false
+    mutable: false
     description: "Unique ID."
 
   runner_type:
     type: enum
     source: runner_type
     nullable: false
+    mutable: false
     description: "Scope: instance, group, or project."
     values:
       1: instance_type
@@ -89,6 +91,7 @@ properties:
     type: timestamp
     source: created_at
     nullable: true
+    mutable: false
     description: "Registration timestamp."
 
   contacted_at:

config/ontology/nodes/ci/stage.yaml

@@ -21,12 +21,14 @@ properties:
     type: int64
     source: id
     nullable: false
+    mutable: false
     description: "Unique ID."
 
   name:
     type: string
     source: name
     nullable: false
+    mutable: false
     description: "Stage name (e.g. build, test, deploy)."
 
   status:
@@ -48,6 +50,7 @@ properties:
       10: waiting_for_resource
       11: waiting_for_callback
       12: canceling
+    terminal_values: [success, failed, canceled, skipped]
 
   position:
     type: int64
@@ -59,6 +62,7 @@ properties:
     type: timestamp
     source: created_at
     nullable: true
+    mutable: false
     description: "Creation timestamp."
 
   updated_at:
@@ -71,12 +75,14 @@ properties:
     type: int64
     source: project_id
     nullable: false
+    mutable: false
     description: "Owning project ID."
 
   pipeline_id:
     type: int64
     source: pipeline_id
     nullable: true
+    mutable: false
     description: "Containing pipeline ID."
 
   traversal_path: