Added rule to make every header should be explicit in defining whethe…

…r it is required (#20)

.github/workflows/ci.yml

@@ -11,7 +11,7 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        node-version: [20.x, 21.x]
+        node-version: [20.x, 22.x, 23.x]
     steps:
       - uses: actions/checkout@v4
       - name: Use Node.js ${{ matrix.node-version }}
@@ -35,7 +35,7 @@ jobs:
     name: Branch Build
     strategy:
       matrix:
-        node-version: [20.x, 21.x]
+        node-version: [20.x, 22.x, 23.x]
     steps:
       - uses: actions/checkout@v4
         with:

package.json

@@ -1,12 +1,12 @@
 {
   "name": "@checkdigit/spectral-config",
-  "version": "2.1.0",
+  "version": "2.1.1",
   "description": "Check Digit Spectral Config",
   "main": "ruleset.json",
   "private": false,
   "prettier": "@checkdigit/prettier-config",
   "engines": {
-    "node": ">=20.11"
+    "node": ">=20.17"
   },
   "files": [
     "ruleset.json"

ruleset.json

@@ -36,6 +36,17 @@
     "oas2-operation-security-defined": "error",
     "oas2-schema": "error",
     "oas2-unused-definition": "error",
-    "oas2-valid-media-example": "error"
+    "oas2-valid-media-example": "error",
+
+    "header-required-property": {
+      "description": "All headers must explicitly define whether they are required.",
+      "message": "Header is missing 'required' property.",
+      "severity": "error",
+      "given": "$.components.headers.*",
+      "then": {
+        "field": "required",
+        "function": "defined"
+      }
+    }
   }
 }

test/openapi.yml

@@ -177,17 +177,20 @@ components:
 
   headers:
     ETag:
+      required: false
       description: Version information for record
       schema:
         type: string
 
     Created-On:
+      required: false
       description: CreatedOn timestamp for the newly created record
       schema:
         type: string
         format: date-time
 
     Updated-On:
+      required: false
       description: UpdatedOn timestamp for the existing record
       schema:
         type: string