example: run custom redocly-cli rules as part of portal build

openapi/petstore.yaml

@@ -1,4 +1,5 @@
 openapi: 3.0.3
+security: []
 servers:
   - url: '//petstore.swagger.io/v2'
 info:
@@ -35,7 +36,7 @@ paths:
         - pet
       summary: Add a new pet to the store
       description: ''
-      operationId: addPet
+      operationId: test
       responses:
         '200':
           description: OK

openapi/reference.page.yaml

@@ -6,3 +6,4 @@ settings:
       - lang: curl
       - lang: JavaScript
       - lang: Node.js
+

plugins/plugin.js

@@ -0,0 +1,14 @@
+const OperationIdNotTest = require('./rules/operation-id-not-test');
+const id = 'plugin';
+
+/** @type {import('@redocly/cli').DecoratorsConfig} */
+const rules = {
+  oas3: {
+    'operation-id-not-test': OperationIdNotTest,
+  },
+};
+
+module.exports = {
+  id,
+  rules,
+};

plugins/rules/operation-id-not-test.js

@@ -0,0 +1,14 @@
+module.exports = OperationIdNotTest;
+
+function OperationIdNotTest() {
+  return {
+    Operation(operation, ctx) {
+      if (operation.operationId === 'test') {
+        ctx.report({
+          message: `operationId must be not "test"`,
+          location: ctx.location.child('operationId'),
+        });
+      }
+    },
+  };
+}

redocly.yaml

@@ -0,0 +1,11 @@
+apis:
+  sample@v1:
+    root: openapi/petstore.yaml
+rules: 
+  plugin/operation-id-not-test:
+    severity: error
+  operation-4xx-response:
+    severity: off
+
+plugins:
+  - "./plugins/plugin.js"