Changes snake cased fields to camel casing

This commit improves consistency in our spec and examples by having all keys be camel cased. This made 4 changes: chain_id -> chainId context_id -> contextId link_kind -> linkKind link_type -> linkType Signed-off-by: xibz <impactbchang@gmail.com>
cdevents · May 14, 2024 · 2816601 · 2816601
1 parent f1dbd63
commit 2816601
Show file tree

Hide file tree

Showing 90 changed files with 302 additions and 280 deletions.
diff --git a/.github/linters/.eslintrc.yml b/.github/linters/.eslintrc.yml
@@ -0,0 +1,21 @@
+plugins:
+  - jsonc
+overrides:
+  - files: "*.json"
+    parser: "jsonc-eslint-parser"
+    rules:
+      # These are the set of rules that belong to jsonc. For more information,
+      # https://ota-meshi.github.io/eslint-plugin-jsonc/rules
+      jsonc/comma-dangle:
+        - error
+      jsonc/indent:
+        - error
+        - 2
+      jsonc/key-name-casing:
+        - error
+        - camelCase: true
+          snake_case: false
+      jsonc/key-spacing:
+        - error
+      jsonc/no-dupe-keys:
+        - error
diff --git a/.github/workflows/main.yml b/.github/workflows/main.yml
@@ -31,6 +31,7 @@ jobs:
           DEFAULT_BRANCH: main
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
           VALIDATE_MARKDOWN: true
+          VALIDATE_JSON: true
 
   jsonschema:
     name: Validate Schemas and Examples

diff --git a/custom/schema.json b/custom/schema.json
@@ -1,93 +1,93 @@
 {
-    "$schema": "https://json-schema.org/draft/2020-12/schema",
-    "$id": "https://cdevents.dev/0.4.0/schema/custom",
-    "properties": {
-      "context": {
-        "properties": {
-          "version": {
-            "type": "string",
-            "minLength": 1
-          },
-          "id": {
-            "type": "string",
-            "minLength": 1
-          },
-          "source": {
-            "type": "string",
-            "minLength": 1,
-            "format": "uri-reference"
-          },
-          "type": {
-            "type": "string",
-            "pattern": "^dev.cdeventsx.[a-zA-Z0-9]+-[a-zA-Z]+.[a-zA-Z]+$"
-          },
-          "timestamp": {
-            "type": "string",
-            "format": "date-time"
-          },
-          "schemaUri": {
-            "type": "string",
-            "minLength": 1,
-            "format": "uri"
-          }
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://cdevents.dev/0.4.0/schema/custom",
+  "properties": {
+    "context": {
+      "properties": {
+        "version": {
+          "type": "string",
+          "minLength": 1
         },
-        "additionalProperties": false,
-        "type": "object",
-        "required": [
-          "version",
-          "id",
-          "source",
-          "type",
-          "timestamp"
-        ]
-      },
-      "subject": {
-        "properties": {
-          "id": {
-            "type": "string",
-            "minLength": 1
-          },
-          "source": {
-            "type": "string",
-            "minLength": 1,
-            "format": "uri-reference"
-          },
-          "type": {
-            "type": "string",
-            "pattern": "^[a-zA-Z0-9]+-[a-zA-Z]+$"
-          },
-          "content": {
-            "type": "object",
-            "additionalProperties": true
-          }
+        "id": {
+          "type": "string",
+          "minLength": 1
+        },
+        "source": {
+          "type": "string",
+          "minLength": 1,
+          "format": "uri-reference"
+        },
+        "type": {
+          "type": "string",
+          "pattern": "^dev.cdeventsx.[a-zA-Z0-9]+-[a-zA-Z]+.[a-zA-Z]+$"
         },
-        "additionalProperties": false,
-        "type": "object",
-        "required": [
-          "id",
-          "type",
-          "content"
-        ]
+        "timestamp": {
+          "type": "string",
+          "format": "date-time"
+        },
+        "schemaUri": {
+          "type": "string",
+          "minLength": 1,
+          "format": "uri"
+        }
       },
-      "customData": {
-        "oneOf": [
-          {
-            "type": "object"
-          },
-          {
-            "type": "string",
-            "contentEncoding": "base64"
-          }
-        ]
+      "additionalProperties": false,
+      "type": "object",
+      "required": [
+        "version",
+        "id",
+        "source",
+        "type",
+        "timestamp"
+      ]
+    },
+    "subject": {
+      "properties": {
+        "id": {
+          "type": "string",
+          "minLength": 1
+        },
+        "source": {
+          "type": "string",
+          "minLength": 1,
+          "format": "uri-reference"
+        },
+        "type": {
+          "type": "string",
+          "pattern": "^[a-zA-Z0-9]+-[a-zA-Z]+$"
+        },
+        "content": {
+          "type": "object",
+          "additionalProperties": true
+        }
       },
-      "customDataContentType": {
-        "type": "string"
-      }
+      "additionalProperties": false,
+      "type": "object",
+      "required": [
+        "id",
+        "type",
+        "content"
+      ]
+    },
+    "customData": {
+      "oneOf": [
+        {
+          "type": "object"
+        },
+        {
+          "type": "string",
+          "contentEncoding": "base64"
+        }
+      ]
     },
-    "additionalProperties": false,
-    "type": "object",
-    "required": [
-      "context",
-      "subject"
-    ]
-  }
+    "customDataContentType": {
+      "type": "string"
+    }
+  },
+  "additionalProperties": false,
+  "type": "object",
+  "required": [
+    "context",
+    "subject"
+  ]
+}
diff --git a/examples/artifact_packaged.json b/examples/artifact_packaged.json
@@ -2,7 +2,7 @@
   "context": {
     "version": "0.4.0",
     "id": "271069a8-fc18-44f1-b38f-9d70a1695819",
-    "chain_id": "4c8cb7dd-3448-41de-8768-eec704e2829b",
+    "chainId": "4c8cb7dd-3448-41de-8768-eec704e2829b",
     "source": "/event/source/123",
     "type": "dev.cdevents.artifact.packaged.0.2.0",
     "timestamp": "2023-03-20T14:27:05.315384Z",

diff --git a/examples/artifact_published.json b/examples/artifact_published.json
@@ -2,7 +2,7 @@
   "context": {
     "version": "0.4.0",
     "id": "271069a8-fc18-44f1-b38f-9d70a1695819",
-    "chain_id": "4c8cb7dd-3448-41de-8768-eec704e2829b",
+    "chainId": "4c8cb7dd-3448-41de-8768-eec704e2829b",
     "source": "/event/source/123",
     "type": "dev.cdevents.artifact.published.0.2.0",
     "timestamp": "2023-03-20T14:27:05.315384Z",

diff --git a/examples/artifact_signed.json b/examples/artifact_signed.json
@@ -2,7 +2,7 @@
   "context": {
     "version": "0.4.0",
     "id": "271069a8-fc18-44f1-b38f-9d70a1695819",
-    "chain_id": "4c8cb7dd-3448-41de-8768-eec704e2829b",
+    "chainId": "4c8cb7dd-3448-41de-8768-eec704e2829b",
     "source": "/event/source/123",
     "type": "dev.cdevents.artifact.signed.0.2.0",
     "timestamp": "2023-03-20T14:27:05.315384Z",

diff --git a/examples/branch_created.json b/examples/branch_created.json
@@ -2,7 +2,7 @@
   "context": {
     "version": "0.4.0",
     "id": "271069a8-fc18-44f1-b38f-9d70a1695819",
-    "chain_id": "4c8cb7dd-3448-41de-8768-eec704e2829b",
+    "chainId": "4c8cb7dd-3448-41de-8768-eec704e2829b",
     "source": "/event/source/123",
     "type": "dev.cdevents.branch.created.0.2.0",
     "timestamp": "2023-03-20T14:27:05.315384Z",

diff --git a/examples/branch_deleted.json b/examples/branch_deleted.json
@@ -2,7 +2,7 @@
   "context": {
     "version": "0.4.0",
     "id": "271069a8-fc18-44f1-b38f-9d70a1695819",
-    "chain_id": "4c8cb7dd-3448-41de-8768-eec704e2829b",
+    "chainId": "4c8cb7dd-3448-41de-8768-eec704e2829b",
     "source": "/event/source/123",
     "type": "dev.cdevents.branch.deleted.0.2.0",
     "timestamp": "2023-03-20T14:27:05.315384Z",

diff --git a/examples/build_finished.json b/examples/build_finished.json
@@ -2,7 +2,7 @@
   "context": {
     "version": "0.4.0",
     "id": "271069a8-fc18-44f1-b38f-9d70a1695819",
-    "chain_id": "4c8cb7dd-3448-41de-8768-eec704e2829b",
+    "chainId": "4c8cb7dd-3448-41de-8768-eec704e2829b",
     "source": "/event/source/123",
     "type": "dev.cdevents.build.finished.0.2.0",
     "timestamp": "2023-03-20T14:27:05.315384Z",

diff --git a/examples/build_queued.json b/examples/build_queued.json
@@ -2,7 +2,7 @@
   "context": {
     "version": "0.4.0",
     "id": "271069a8-fc18-44f1-b38f-9d70a1695819",
-    "chain_id": "4c8cb7dd-3448-41de-8768-eec704e2829b",
+    "chainId": "4c8cb7dd-3448-41de-8768-eec704e2829b",
     "source": "/event/source/123",
     "type": "dev.cdevents.build.queued.0.2.0",
     "timestamp": "2023-03-20T14:27:05.315384Z",

diff --git a/examples/build_started.json b/examples/build_started.json
@@ -2,7 +2,7 @@
   "context": {
     "version": "0.4.0",
     "id": "271069a8-fc18-44f1-b38f-9d70a1695819",
-    "chain_id": "4c8cb7dd-3448-41de-8768-eec704e2829b",
+    "chainId": "4c8cb7dd-3448-41de-8768-eec704e2829b",
     "source": "/event/source/123",
     "type": "dev.cdevents.build.started.0.2.0",
     "timestamp": "2023-03-20T14:27:05.315384Z",

diff --git a/examples/change_abandoned.json b/examples/change_abandoned.json
@@ -2,7 +2,7 @@
   "context": {
     "version": "0.4.0",
     "id": "271069a8-fc18-44f1-b38f-9d70a1695819",
-    "chain_id": "4c8cb7dd-3448-41de-8768-eec704e2829b",
+    "chainId": "4c8cb7dd-3448-41de-8768-eec704e2829b",
     "source": "/event/source/123",
     "type": "dev.cdevents.change.abandoned.0.2.0",
     "timestamp": "2023-03-20T14:27:05.315384Z",

diff --git a/examples/change_created.json b/examples/change_created.json
@@ -2,7 +2,7 @@
   "context": {
     "version": "0.4.0",
     "id": "271069a8-fc18-44f1-b38f-9d70a1695819",
-    "chain_id": "4c8cb7dd-3448-41de-8768-eec704e2829b",
+    "chainId": "4c8cb7dd-3448-41de-8768-eec704e2829b",
     "source": "/event/source/123",
     "type": "dev.cdevents.change.created.0.3.0",
     "timestamp": "2023-03-20T14:27:05.315384Z",

diff --git a/examples/change_merged.json b/examples/change_merged.json
@@ -2,7 +2,7 @@
   "context": {
     "version": "0.4.0",
     "id": "271069a8-fc18-44f1-b38f-9d70a1695819",
-    "chain_id": "4c8cb7dd-3448-41de-8768-eec704e2829b",
+    "chainId": "4c8cb7dd-3448-41de-8768-eec704e2829b",
     "source": "/event/source/123",
     "type": "dev.cdevents.change.merged.0.2.0",
     "timestamp": "2023-03-20T14:27:05.315384Z",

diff --git a/examples/change_reviewed.json b/examples/change_reviewed.json
@@ -2,7 +2,7 @@
   "context": {
     "version": "0.4.0",
     "id": "271069a8-fc18-44f1-b38f-9d70a1695819",
-    "chain_id": "4c8cb7dd-3448-41de-8768-eec704e2829b",
+    "chainId": "4c8cb7dd-3448-41de-8768-eec704e2829b",
     "source": "/event/source/123",
     "type": "dev.cdevents.change.reviewed.0.2.0",
     "timestamp": "2023-03-20T14:27:05.315384Z",

diff --git a/examples/change_updated.json b/examples/change_updated.json
@@ -2,7 +2,7 @@
   "context": {
     "version": "0.4.0",
     "id": "271069a8-fc18-44f1-b38f-9d70a1695819",
-    "chain_id": "4c8cb7dd-3448-41de-8768-eec704e2829b",
+    "chainId": "4c8cb7dd-3448-41de-8768-eec704e2829b",
     "source": "/event/source/123",
     "type": "dev.cdevents.change.updated.0.2.0",
     "timestamp": "2023-03-20T14:27:05.315384Z",

diff --git a/examples/environment_created.json b/examples/environment_created.json
@@ -2,7 +2,7 @@
   "context": {
     "version": "0.4.0",
     "id": "271069a8-fc18-44f1-b38f-9d70a1695819",
-    "chain_id": "4c8cb7dd-3448-41de-8768-eec704e2829b",
+    "chainId": "4c8cb7dd-3448-41de-8768-eec704e2829b",
     "source": "/event/source/123",
     "type": "dev.cdevents.environment.created.0.2.0",
     "timestamp": "2023-03-20T14:27:05.315384Z",

diff --git a/examples/environment_deleted.json b/examples/environment_deleted.json
@@ -2,7 +2,7 @@
   "context": {
     "version": "0.4.0",
     "id": "271069a8-fc18-44f1-b38f-9d70a1695819",
-    "chain_id": "4c8cb7dd-3448-41de-8768-eec704e2829b",
+    "chainId": "4c8cb7dd-3448-41de-8768-eec704e2829b",
     "source": "/event/source/123",
     "type": "dev.cdevents.environment.deleted.0.2.0",
     "timestamp": "2023-03-20T14:27:05.315384Z",

diff --git a/examples/environment_modified.json b/examples/environment_modified.json
@@ -2,7 +2,7 @@
   "context": {
     "version": "0.4.0",
     "id": "271069a8-fc18-44f1-b38f-9d70a1695819",
-    "chain_id": "4c8cb7dd-3448-41de-8768-eec704e2829b",
+    "chainId": "4c8cb7dd-3448-41de-8768-eec704e2829b",
     "source": "/event/source/123",
     "type": "dev.cdevents.environment.modified.0.2.0",
     "timestamp": "2023-03-20T14:27:05.315384Z",