@checkdigit/spectral-config 4.0.0-PR.24-cdae → 4.0.0-PR.28-7b96

package/LICENSE

@@ -1,6 +1,6 @@
 The MIT License
 
-Copyright (c) 2021-2024 Check Digit, LLC
+Copyright (c) 2021-2026 Check Digit, LLC
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

package/README.md

@@ -55,17 +55,10 @@ Install Spectral, by Spotlight https://marketplace.visualstudio.com/items?itemNa
 
 ### Rules for Certain Warnings and Errors
 
-#### `no-operationId-allowed`
+`operation-operationId  Operation must have "operationId"`
 
-The `no-operationId-allowed` rule enforces that `operationId` field **must not** be in the operations.
+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`
 
-**Rationale:**  
-The use of `operationId` require manual effort and can lead to inconsistencies and maintenance challenges. By disallowing `operationId`, we automatically maintain a consistent naming convention as part of our code generation tool chain rely on paths and HTTP methods for operation identification.
+## License
 
-**Migration Guidance:**
-
-- Remove any `operationId` fields.
-- References to the previously generated Koa router Context typings:
-  - Update the openapi related code generation dependencies, and update npm script `prepare` according to the coding standards to activate the koa router typing support.
-  - with koa router typing supported enabled, the typing references should now be able to removed from the router implementation.
-  - just in case the types need to be used in somewhere else, they'll follow `${Path}${Method}` pattern in PascalCase. For example, `PUT /account/{accountId}:` will translate to AccountPutContext.
+MIT

package/package.json

@@ -1 +1 @@
-{"name":"@checkdigit/spectral-config","version":"4.0.0-PR.24-cdae","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":"4.0.0-PR.28-7b96","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":"MIT","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 . --check","prettier:fix":"prettier . --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":"^8.1.1"},"peerDependencies":{"@stoplight/spectral-cli":"6.16.3"},"engines":{"node":">=24.18.0"},"allowScripts":{"@scarf/scarf@1.4.0":false}}

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[*][get,put,post,patch,delete,options,head,trace]",
-      "then": {
-        "function": "schema",
-        "functionOptions": {
-          "schema": {
-            "type": "object",
-            "not": {
-              "required": ["operationId"]
-            }
-          }
-        }
-      }
     }
   }
 }