@checkdigit/spectral-config 3.1.0-PR.24-701d → 4.0.0-PR.24-cdae

package/README.md

@@ -54,3 +54,18 @@ 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
+
+#### `no-operationId-allowed`
+
+The `no-operationId-allowed` rule enforces that `operationId` field **must not** be in the operations.
+
+**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.
+
+**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.

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":"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"}}

package/ruleset.json

@@ -48,7 +48,7 @@
       "description": "operationId is not allowed in our API style.",
       "message": "Remove `operationId` from operations.",
       "severity": "error",
-      "given": "$.paths[*][*]",
+      "given": "$.paths[*][get,put,post,patch,delete,options,head,trace]",
       "then": {
         "function": "schema",
         "functionOptions": {