@checkdigit/spectral-config 3.1.0-PR.24-701d → 3.1.0-PR.26-2219

package/README.md

@@ -54,3 +54,7 @@ Set Included files to the following glob pattern `**/*swagger.yml`.
 Install Spectral, by Spotlight https://marketplace.visualstudio.com/items?itemName=stoplight.spectral
 
 ### Rules for Certain Warnings and Errors
+
+`operation-operationId  Operation must have "operationId"`
+
+Add an operationId to the operation. Check Digit uses a `noun-noun-verb` naming convention. For example, the correct operationId for a `PUT` to path `/resource/{id}/item/{itemId}/key` is `resource-item-key-put`

package/package.json

@@ -1 +1 @@
-{"name":"@checkdigit/spectral-config","version":"3.1.0-PR.24-701d","private":false,"description":"Check Digit Spectral Config","homepage":"https://github.com/checkdigit/spectral-config#readme","bugs":{"url":"https://github.com/checkdigit/spectral-config/issues"},"repository":{"type":"git","url":"git+https://github.com/checkdigit/spectral-config.git"},"license":"UNLICENSED","author":"Check Digit, LLC","main":"ruleset.json","files":["ruleset.json"],"scripts":{"ci:compile":"","ci:coverage":"","ci:lint":"npm run lint","ci:style":"npm run prettier","ci:test":"spectral lint test/openapi.yml --ruleset test/.spectral.json","lint":"","lint:fix":"","prettier":"prettier --ignore-path .gitignore --list-different .","prettier:fix":"prettier --ignore-path .gitignore --write .","test":"npm run ci:compile && npm run ci:test && npm run ci:style && npm run ci:lint"},"prettier":"@checkdigit/prettier-config","devDependencies":{"@checkdigit/prettier-config":"^7.1.2"},"peerDependencies":{"@stoplight/spectral-cli":"6.15.0"},"engines":{"node":">=22.18"}}
+{"name":"@checkdigit/spectral-config","version":"3.1.0-PR.26-2219","private":false,"description":"Check Digit Spectral Config","homepage":"https://github.com/checkdigit/spectral-config#readme","bugs":{"url":"https://github.com/checkdigit/spectral-config/issues"},"repository":{"type":"git","url":"git+https://github.com/checkdigit/spectral-config.git"},"license":"UNLICENSED","author":"Check Digit, LLC","main":"ruleset.json","files":["ruleset.json","spectral-schema-resolver.cjs"],"scripts":{"ci:compile":"","ci:coverage":"","ci:lint":"npm run lint","ci:style":"npm run prettier","ci:test":"spectral lint test/openapi.yml --ruleset test/.spectral.json","lint":"","lint:fix":"","oas31":"spectral lint test/openapi-31.yml --ruleset test/.spectral.json --resolver=spectral-schema-resolver.cjs","prettier":"prettier --ignore-path .gitignore --list-different .","prettier:fix":"prettier --ignore-path .gitignore --write .","test":"npm run ci:compile && npm run ci:test && npm run ci:style && npm run ci:lint"},"prettier":"@checkdigit/prettier-config","devDependencies":{"@checkdigit/currency":"7.1.0-PR.27-f937","@checkdigit/prettier-config":"^6.0.0"},"peerDependencies":{"@stoplight/json-ref-readers":"1.2.2","@stoplight/json-ref-resolver":"3.1.6","@stoplight/spectral-cli":"6.15.0"},"engines":{"node":">=22.18"}}

package/ruleset.json

@@ -2,14 +2,18 @@
   "extends": ["spectral:oas"],
   "rules": {
     "no-$ref-siblings": "off",
+
     "info-contact": "error",
     "info-description": "error",
     "duplicated-entry-in-enum": "error",
     "operation-success-response": "error",
+    "operation-operationId-unique": "error",
     "operation-tag-defined": "error",
     "no-eval-in-markdown": "error",
     "no-script-tags-in-markdown": "error",
     "operation-description": "error",
+    "operation-operationId": "error",
+    "operation-operationId-valid-in-url": "error",
     "operation-tags": "error",
     "path-declarations-must-exist": "error",
     "path-keys-no-trailing-slash": "error",
@@ -20,8 +24,10 @@
     "oas3-operation-security-defined": "error",
     "oas3-server-trailing-slash": "error",
     "oas3-unused-component": "error",
+
     "oas2-api-host": "off",
     "oas2-api-schemes": "off",
+
     "oas2-anyOf": "error",
     "oas2-discriminator": "error",
     "oas2-host-trailing-slash": "error",
@@ -31,6 +37,7 @@
     "oas2-schema": "error",
     "oas2-unused-definition": "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.",
@@ -40,26 +47,6 @@
         "field": "required",
         "function": "defined"
       }
-    },
-    "operation-operationId": "off",
-    "operation-operationId-unique": "off",
-    "operation-operationId-valid-in-url": "off",
-    "no-operationId-allowed": {
-      "description": "operationId is not allowed in our API style.",
-      "message": "Remove `operationId` from operations.",
-      "severity": "error",
-      "given": "$.paths[*][*]",
-      "then": {
-        "function": "schema",
-        "functionOptions": {
-          "schema": {
-            "type": "object",
-            "not": {
-              "required": ["operationId"]
-            }
-          }
-        }
-      }
     }
   }
 }

package/spectral-schema-resolver.cjs

@@ -0,0 +1,35 @@
+'use strict';
+
+const fs = require('node:fs');
+
+const { schemaResolver } = require('@checkdigit/openapi');
+
+const { Resolver } = require('@stoplight/json-ref-resolver');
+const { resolveFile } = require('@stoplight/json-ref-readers');
+
+const resolver = new Resolver({
+  resolvers: {
+    file: { resolve: resolveFile },
+    https: {
+      resolve: (uri) => {
+        const url = uri.href();
+        if (schemaResolver.isHttpsSchemaReferenceUrl(url)) {
+          const localSchemaPath = schemaResolver.mapHttpsToLocalResourcePath(url);
+          return fs.readFileSync(localSchemaPath, 'utf8');
+        }
+        throw new Error(`Unable to resolve https:// schema URL: ${uri}`);
+      },
+    },
+    service: {
+      resolve: (uri) => {
+        const url = uri.href();
+        if (schemaResolver.isServiceSchemaReferenceUrl(url)) {
+          const localSchemaPath = schemaResolver.mapServiceToLocalResourcePath(url);
+          return fs.readFileSync(localSchemaPath, 'utf8');
+        }
+        throw new Error(`Unable to resolve service:// schema URL: ${uri}`);
+      },
+    },
+  },
+});
+module.exports = resolver;