Fix references to link schemas

Make the references start with a / and include the whole path relative to the main schema base URL. See https://json-schema.org/understanding-json-schema/structuring#dollarref Schemas from the PR may not be published yet, so adapt the CI job to look for local files instead. Signed-off-by: Andrea Frittoli <[email protected]>
cdevents · Mar 6, 2024 · a8eab81 · a8eab81
1 parent 46702c3
commit a8eab81
Show file tree

Hide file tree

Showing 42 changed files with 52 additions and 43 deletions.
diff --git a/schemas/artifactdeleted.json b/schemas/artifactdeleted.json
@@ -38,7 +38,7 @@
           "minLength": 1
         },
         "links": {
-          "$ref": "links/embeddedlinksarray.json"
+          "$ref": "/schema/links/embeddedlinksarray.json"
         }
       },
       "additionalProperties": false,

diff --git a/schemas/artifactdownloaded.json b/schemas/artifactdownloaded.json
@@ -38,7 +38,7 @@
           "minLength": 1
         },
         "links": {
-          "$ref": "links/embeddedlinksarray.json"
+          "$ref": "/schema/links/embeddedlinksarray.json"
         }
       },
       "additionalProperties": false,

diff --git a/schemas/artifactpackaged.json b/schemas/artifactpackaged.json
@@ -38,7 +38,7 @@
           "minLength": 1
         },
         "links": {
-          "$ref": "links/embeddedlinksarray.json"
+          "$ref": "/schema/links/embeddedlinksarray.json"
         }
       },
       "additionalProperties": false,

diff --git a/schemas/artifactpublished.json b/schemas/artifactpublished.json
@@ -38,7 +38,7 @@
           "minLength": 1
         },
         "links": {
-          "$ref": "links/embeddedlinksarray.json"
+          "$ref": "/schema/links/embeddedlinksarray.json"
         }
       },
       "additionalProperties": false,

diff --git a/schemas/artifactsigned.json b/schemas/artifactsigned.json
@@ -38,7 +38,7 @@
           "minLength": 1
         },
         "links": {
-          "$ref": "links/embeddedlinksarray.json"
+          "$ref": "/schema/links/embeddedlinksarray.json"
         }
       },
       "additionalProperties": false,

diff --git a/schemas/branchcreated.json b/schemas/branchcreated.json
@@ -38,7 +38,7 @@
           "minLength": 1
         },
         "links": {
-          "$ref": "links/embeddedlinksarray.json"
+          "$ref": "/schema/links/embeddedlinksarray.json"
         }
       },
       "additionalProperties": false,

diff --git a/schemas/branchdeleted.json b/schemas/branchdeleted.json
@@ -38,7 +38,7 @@
           "minLength": 1
         },
         "links": {
-          "$ref": "links/embeddedlinksarray.json"
+          "$ref": "/schema/links/embeddedlinksarray.json"
         }
       },
       "additionalProperties": false,

diff --git a/schemas/buildfinished.json b/schemas/buildfinished.json
@@ -38,7 +38,7 @@
           "minLength": 1
         },
         "links": {
-          "$ref": "links/embeddedlinksarray.json"
+          "$ref": "/schema/links/embeddedlinksarray.json"
         }
       },
       "additionalProperties": false,

diff --git a/schemas/buildqueued.json b/schemas/buildqueued.json
@@ -38,7 +38,7 @@
           "minLength": 1
         },
         "links": {
-          "$ref": "links/embeddedlinksarray.json"
+          "$ref": "/schema/links/embeddedlinksarray.json"
         }
       },
       "additionalProperties": false,

diff --git a/schemas/buildstarted.json b/schemas/buildstarted.json
@@ -38,7 +38,7 @@
           "minLength": 1
         },
         "links": {
-          "$ref": "links/embeddedlinksarray.json"
+          "$ref": "/schema/links/embeddedlinksarray.json"
         }
       },
       "additionalProperties": false,

diff --git a/schemas/changeabandoned.json b/schemas/changeabandoned.json
@@ -38,7 +38,7 @@
           "minLength": 1
         },
         "links": {
-          "$ref": "links/embeddedlinksarray.json"
+          "$ref": "/schema/links/embeddedlinksarray.json"
         }
       },
       "additionalProperties": false,

diff --git a/schemas/changecreated.json b/schemas/changecreated.json
@@ -38,7 +38,7 @@
           "minLength": 1
         },
         "links": {
-          "$ref": "links/embeddedlinksarray.json"
+          "$ref": "/schema/links/embeddedlinksarray.json"
         }
       },
       "additionalProperties": false,

diff --git a/schemas/changemerged.json b/schemas/changemerged.json
@@ -38,7 +38,7 @@
           "minLength": 1
         },
         "links": {
-          "$ref": "links/embeddedlinksarray.json"
+          "$ref": "/schema/links/embeddedlinksarray.json"
         }
       },
       "additionalProperties": false,

diff --git a/schemas/changereviewed.json b/schemas/changereviewed.json
@@ -38,7 +38,7 @@
           "minLength": 1
         },
         "links": {
-          "$ref": "links/embeddedlinksarray.json"
+          "$ref": "/schema/links/embeddedlinksarray.json"
         }
       },
       "additionalProperties": false,

diff --git a/schemas/changeupdated.json b/schemas/changeupdated.json
@@ -38,7 +38,7 @@
           "minLength": 1
         },
         "links": {
-          "$ref": "links/embeddedlinksarray.json"
+          "$ref": "/schema/links/embeddedlinksarray.json"
         }
       },
       "additionalProperties": false,

diff --git a/schemas/environmentcreated.json b/schemas/environmentcreated.json
@@ -38,7 +38,7 @@
           "minLength": 1
         },
         "links": {
-          "$ref": "links/embeddedlinksarray.json"
+          "$ref": "/schema/links/embeddedlinksarray.json"
         }
       },
       "additionalProperties": false,

diff --git a/schemas/environmentdeleted.json b/schemas/environmentdeleted.json
@@ -38,7 +38,7 @@
           "minLength": 1
         },
         "links": {
-          "$ref": "links/embeddedlinksarray.json"
+          "$ref": "/schema/links/embeddedlinksarray.json"
         }
       },
       "additionalProperties": false,

diff --git a/schemas/environmentmodified.json b/schemas/environmentmodified.json
@@ -38,7 +38,7 @@
           "minLength": 1
         },
         "links": {
-          "$ref": "links/embeddedlinksarray.json"
+          "$ref": "/schema/links/embeddedlinksarray.json"
         }
       },
       "additionalProperties": false,

diff --git a/schemas/incidentdetected.json b/schemas/incidentdetected.json
@@ -38,7 +38,7 @@
           "minLength": 1
         },
         "links": {
-          "$ref": "links/embeddedlinksarray.json"
+          "$ref": "/schema/links/embeddedlinksarray.json"
         }
       },
       "additionalProperties": false,

diff --git a/schemas/incidentreported.json b/schemas/incidentreported.json
@@ -38,7 +38,7 @@
           "minLength": 1
         },
         "links": {
-          "$ref": "links/embeddedlinksarray.json"
+          "$ref": "/schema/links/embeddedlinksarray.json"
         }
       },
       "additionalProperties": false,

diff --git a/schemas/incidentresolved.json b/schemas/incidentresolved.json
@@ -38,7 +38,7 @@
           "minLength": 1
         },
         "links": {
-          "$ref": "links/embeddedlinksarray.json"
+          "$ref": "/schema/links/embeddedlinksarray.json"
         }
       },
       "additionalProperties": false,

diff --git a/schemas/pipelinerunfinished.json b/schemas/pipelinerunfinished.json
@@ -38,7 +38,7 @@
           "minLength": 1
         },
         "links": {
-          "$ref": "links/embeddedlinksarray.json"
+          "$ref": "/schema/links/embeddedlinksarray.json"
         }
       },
       "additionalProperties": false,

diff --git a/schemas/pipelinerunqueued.json b/schemas/pipelinerunqueued.json
@@ -38,7 +38,7 @@
           "minLength": 1
         },
         "links": {
-          "$ref": "links/embeddedlinksarray.json"
+          "$ref": "/schema/links/embeddedlinksarray.json"
         }
       },
       "additionalProperties": false,

diff --git a/schemas/pipelinerunstarted.json b/schemas/pipelinerunstarted.json
@@ -38,7 +38,7 @@
           "minLength": 1
         },
         "links": {
-          "$ref": "links/embeddedlinksarray.json"
+          "$ref": "/schema/links/embeddedlinksarray.json"
         }
       },
       "additionalProperties": false,

diff --git a/schemas/repositorycreated.json b/schemas/repositorycreated.json
@@ -38,7 +38,7 @@
           "minLength": 1
         },
         "links": {
-          "$ref": "links/embeddedlinksarray.json"
+          "$ref": "/schema/links/embeddedlinksarray.json"
         }
       },
       "additionalProperties": false,

diff --git a/schemas/repositorydeleted.json b/schemas/repositorydeleted.json
@@ -38,7 +38,7 @@
           "minLength": 1
         },
         "links": {
-          "$ref": "links/embeddedlinksarray.json"
+          "$ref": "/schema/links/embeddedlinksarray.json"
         }
       },
       "additionalProperties": false,

diff --git a/schemas/repositorymodified.json b/schemas/repositorymodified.json
@@ -38,7 +38,7 @@
           "minLength": 1
         },
         "links": {
-          "$ref": "links/embeddedlinksarray.json"
+          "$ref": "/schema/links/embeddedlinksarray.json"
         }
       },
       "additionalProperties": false,

diff --git a/schemas/servicedeployed.json b/schemas/servicedeployed.json
@@ -38,7 +38,7 @@
           "minLength": 1
         },
         "links": {
-          "$ref": "links/embeddedlinksarray.json"
+          "$ref": "/schema/links/embeddedlinksarray.json"
         }
       },
       "additionalProperties": false,

diff --git a/schemas/servicepublished.json b/schemas/servicepublished.json
@@ -38,7 +38,7 @@
           "minLength": 1
         },
         "links": {
-          "$ref": "links/embeddedlinksarray.json"
+          "$ref": "/schema/links/embeddedlinksarray.json"
         }
       },
       "additionalProperties": false,

diff --git a/schemas/serviceremoved.json b/schemas/serviceremoved.json
@@ -38,7 +38,7 @@
           "minLength": 1
         },
         "links": {
-          "$ref": "links/embeddedlinksarray.json"
+          "$ref": "/schema/links/embeddedlinksarray.json"
         }
       },
       "additionalProperties": false,

diff --git a/schemas/servicerolledback.json b/schemas/servicerolledback.json
@@ -38,7 +38,7 @@
           "minLength": 1
         },
         "links": {
-          "$ref": "links/embeddedlinksarray.json"
+          "$ref": "/schema/links/embeddedlinksarray.json"
         }
       },
       "additionalProperties": false,

diff --git a/schemas/serviceupgraded.json b/schemas/serviceupgraded.json
@@ -38,7 +38,7 @@
           "minLength": 1
         },
         "links": {
-          "$ref": "links/embeddedlinksarray.json"
+          "$ref": "/schema/links/embeddedlinksarray.json"
         }
       },
       "additionalProperties": false,

diff --git a/schemas/taskrunfinished.json b/schemas/taskrunfinished.json
@@ -38,7 +38,7 @@
           "minLength": 1
         },
         "links": {
-          "$ref": "links/embeddedlinksarray.json"
+          "$ref": "/schema/links/embeddedlinksarray.json"
         }
       },
       "additionalProperties": false,

diff --git a/schemas/taskrunstarted.json b/schemas/taskrunstarted.json
@@ -38,7 +38,7 @@
           "minLength": 1
         },
         "links": {
-          "$ref": "links/embeddedlinksarray.json"
+          "$ref": "/schema/links/embeddedlinksarray.json"
         }
       },
       "additionalProperties": false,

diff --git a/schemas/testcaserunfinished.json b/schemas/testcaserunfinished.json
@@ -37,7 +37,7 @@
           "minLength": 1
         },
         "links": {
-          "$ref": "links/embeddedlinksarray.json"
+          "$ref": "/schema/links/embeddedlinksarray.json"
         }
       },
       "additionalProperties": false,

diff --git a/schemas/testcaserunqueued.json b/schemas/testcaserunqueued.json
@@ -37,7 +37,7 @@
           "minLength": 1
         },
         "links": {
-          "$ref": "links/embeddedlinksarray.json"
+          "$ref": "/schema/links/embeddedlinksarray.json"
         }
       },
       "additionalProperties": false,

diff --git a/schemas/testcaserunstarted.json b/schemas/testcaserunstarted.json
@@ -37,7 +37,7 @@
           "minLength": 1
         },
         "links": {
-          "$ref": "links/embeddedlinksarray.json"
+          "$ref": "/schema/links/embeddedlinksarray.json"
         }
       },
       "additionalProperties": false,

diff --git a/schemas/testoutputpublished.json b/schemas/testoutputpublished.json
@@ -37,7 +37,7 @@
           "minLength": 1
         },
         "links": {
-          "$ref": "links/embeddedlinksarray.json"
+          "$ref": "/schema/links/embeddedlinksarray.json"
         }
       },
       "additionalProperties": false,

diff --git a/schemas/testsuiterunfinished.json b/schemas/testsuiterunfinished.json
@@ -37,7 +37,7 @@
           "minLength": 1
         },
         "links": {
-          "$ref": "links/embeddedlinksarray.json"
+          "$ref": "/schema/links/embeddedlinksarray.json"
         }
       },
       "additionalProperties": false,

diff --git a/schemas/testsuiterunqueued.json b/schemas/testsuiterunqueued.json
@@ -37,7 +37,7 @@
           "minLength": 1
         },
         "links": {
-          "$ref": "links/embeddedlinksarray.json"
+          "$ref": "/schema/links/embeddedlinksarray.json"
         }
       },
       "additionalProperties": false,

diff --git a/schemas/testsuiterunstarted.json b/schemas/testsuiterunstarted.json
@@ -37,7 +37,7 @@
           "minLength": 1
         },
         "links": {
-          "$ref": "links/embeddedlinksarray.json"
+          "$ref": "/schema/links/embeddedlinksarray.json"
         }
       },
       "additionalProperties": false,

diff --git a/tools/verify-examples.sh b/tools/verify-examples.sh
@@ -37,9 +37,17 @@ EXAMPLES_FOLDER="${ROOT}/examples"
 SCHEMAS_FOLDER="${ROOT}/schemas"
 
 # Install the tool
-cd ${ROOT}/tools
+cd "${ROOT}/tools"
 go install github.com/neilpa/[email protected]
 
+function local_schema() {
+  local SCHEMA=$1
+
+  # Draft version schemas may have not been published yet
+  # Rewrite referenced IDs to the corresponding local files
+  sed 's,"$ref": "/schema,"$ref": "file://'${ROOT}'/schemas,g' "${SCHEMA}" > "${SCHEMA}.local"
+}
+
 # Loop over all example files
 # - examples are subject_predicate.json
 # - schemas are subjectpredicate.json
@@ -52,9 +60,10 @@ for example in $(find "${EXAMPLES_FOLDER}" -type f -name '*json'); do
     SUBJECT=${splitArray[0]}
     PREDICATE=${splitArray[1]}
     SCHEMA_FILE=${SCHEMAS_FOLDER}/${SUBJECT}${PREDICATE}.json
+    local_schema "${SCHEMA_FILE}"
     echo "==> $SUBJECT $PREDICATE"
     echo yajsv -s "$SCHEMA_FILE" "$example"
-    yajsv -s "$SCHEMA_FILE" "$example" || num_failed=$(( num_failed + 1 ))
+    yajsv -s "${SCHEMA_FILE}.local" "$example" || num_failed=$(( num_failed + 1 ))
     echo
 done