chore: add new JSDoc endpoint check rule

Author: MattDevy

specification/cat/aliases/CatAliasesRequest.ts

@@ -26,7 +26,6 @@ import { CatAliasesColumns, CatRequestBase } from '@cat/_types/CatBase'
  *
  * Get the cluster's index aliases, including filter and routing information.
  * This API does not return data stream aliases.
- *
  * IMPORTANT: CAT APIs are only intended for human consumption using the command line or the Kibana console. They are not intended for use by applications. For application consumption, use the aliases API.
  * @rest_spec_name cat.aliases
  * @availability stack stability=stable

specification/eslint.config.js

@@ -16,85 +16,86 @@
  * specific language governing permissions and limitations
  * under the License.
  */
-import parser from '@typescript-eslint/parser'
-import validator from 'eslint-plugin-es-spec'
-import { defineConfig } from 'eslint/config'
+import parser from "@typescript-eslint/parser";
+import validator from "eslint-plugin-es-spec";
+import { defineConfig } from "eslint/config";
 
 export default defineConfig({
-  files: ['**/*.ts'],
+  files: ["**/*.ts"],
   languageOptions: {
     parser,
     parserOptions: {
       projectService: true,
-      tsconfigRootDir: import.meta.dirname
-    }
+      tsconfigRootDir: import.meta.dirname,
+    },
   },
-  plugins: { 'es-spec-validator': validator },
+  plugins: { "es-spec-validator": validator },
   rules: {
-    'es-spec-validator/single-key-dictionary-key-is-string': 'error',
-    'es-spec-validator/dictionary-key-is-string': 'error',
-    'es-spec-validator/no-native-types': 'error',
-    'es-spec-validator/invalid-node-types': 'error',
-    'es-spec-validator/no-generic-number': 'error',
-    'es-spec-validator/request-must-have-urls': 'error',
-    'es-spec-validator/no-variants-on-responses': 'error',
-    'es-spec-validator/no-inline-unions': 'error',
-    'es-spec-validator/prefer-tagged-variants': 'error',
-    'es-spec-validator/no-duplicate-type-names': [
-      'error',
+    "es-spec-validator/single-key-dictionary-key-is-string": "error",
+    "es-spec-validator/dictionary-key-is-string": "error",
+    "es-spec-validator/no-native-types": "error",
+    "es-spec-validator/invalid-node-types": "error",
+    "es-spec-validator/no-generic-number": "error",
+    "es-spec-validator/request-must-have-urls": "error",
+    "es-spec-validator/no-variants-on-responses": "error",
+    "es-spec-validator/no-inline-unions": "error",
+    "es-spec-validator/prefer-tagged-variants": "error",
+    "es-spec-validator/no-duplicate-type-names": [
+      "error",
       {
-        ignoreNames: ['Request', 'Response', 'ResponseBase'],
+        ignoreNames: ["Request", "Response", "ResponseBase"],
         existingDuplicates: {
           Action: [
-            'indices.modify_data_stream',
-            'indices.update_aliases',
-            'watcher._types'
+            "indices.modify_data_stream",
+            "indices.update_aliases",
+            "watcher._types",
           ],
-          Actions: ['ilm._types', 'security.put_privileges', 'watcher._types'],
-          ComponentTemplate: ['cat.component_templates', 'cluster._types'],
+          Actions: ["ilm._types", "security.put_privileges", "watcher._types"],
+          ComponentTemplate: ["cat.component_templates", "cluster._types"],
           Context: [
-            '_global.get_script_context',
-            '_global.search._types',
-            'nodes._types'
+            "_global.get_script_context",
+            "_global.search._types",
+            "nodes._types",
           ],
           DatabaseConfigurationMetadata: [
-            'ingest.get_geoip_database',
-            'ingest.get_ip_location_database'
+            "ingest.get_geoip_database",
+            "ingest.get_ip_location_database",
           ],
-          Datafeed: ['ml._types', 'xpack.usage'],
-          Destination: ['_global.reindex', 'transform._types'],
-          Feature: ['features._types', 'indices.get', 'xpack.info'],
-          Features: ['indices.get', 'xpack.info'],
-          Filter: ['_global.termvectors', 'ml._types'],
-          IndexingPressure: ['cluster.stats', 'indices._types', 'nodes._types'],
-          IndexingPressureMemory: ['indices._types', 'nodes._types'],
-          Ingest: ['ingest._types', 'nodes._types'],
+          Datafeed: ["ml._types", "xpack.usage"],
+          Destination: ["_global.reindex", "transform._types"],
+          Feature: ["features._types", "indices.get", "xpack.info"],
+          Features: ["indices.get", "xpack.info"],
+          Filter: ["_global.termvectors", "ml._types"],
+          IndexingPressure: ["cluster.stats", "indices._types", "nodes._types"],
+          IndexingPressureMemory: ["indices._types", "nodes._types"],
+          Ingest: ["ingest._types", "nodes._types"],
           MigrationFeature: [
-            'migration.get_feature_upgrade_status',
-            'migration.post_feature_upgrade'
+            "migration.get_feature_upgrade_status",
+            "migration.post_feature_upgrade",
           ],
-          Operation: ['_global.mget', '_global.mtermvectors'],
-          ResponseBody: ['_global.search', 'ml.evaluate_data_frame'],
-          Phase: ['ilm._types', 'xpack.usage'],
-          Phases: ['ilm._types', 'xpack.usage'],
-          Pipeline: ['ingest._types', 'logstash._types'],
-          Policy: ['enrich._types', 'ilm._types', 'slm._types'],
-          RequestItem: ['_global.msearch', '_global.msearch_template'],
-          ResponseItem: ['_global.bulk', '_global.mget', '_global.msearch'],
-          RoleMapping: ['security._types', 'xpack.usage'],
-          RuntimeFieldTypes: ['cluster.stats', 'xpack.usage'],
-          ShardsStats: ['indices.field_usage_stats', 'snapshot._types'],
-          ShardStats: ['ccr._types', 'indices.stats'],
-          Source: ['_global.reindex', 'transform._types'],
+          Operation: ["_global.mget", "_global.mtermvectors"],
+          ResponseBody: ["_global.search", "ml.evaluate_data_frame"],
+          Phase: ["ilm._types", "xpack.usage"],
+          Phases: ["ilm._types", "xpack.usage"],
+          Pipeline: ["ingest._types", "logstash._types"],
+          Policy: ["enrich._types", "ilm._types", "slm._types"],
+          RequestItem: ["_global.msearch", "_global.msearch_template"],
+          ResponseItem: ["_global.bulk", "_global.mget", "_global.msearch"],
+          RoleMapping: ["security._types", "xpack.usage"],
+          RuntimeFieldTypes: ["cluster.stats", "xpack.usage"],
+          ShardsStats: ["indices.field_usage_stats", "snapshot._types"],
+          ShardStats: ["ccr._types", "indices.stats"],
+          Source: ["_global.reindex", "transform._types"],
           Token: [
-            '_global.termvectors',
-            'security.authenticate',
-            'security.create_service_token',
-            'security.enroll_kibana'
-          ]
-        }
-      }
+            "_global.termvectors",
+            "security.authenticate",
+            "security.create_service_token",
+            "security.enroll_kibana",
+          ],
+        },
+      },
     ],
-    'es-spec-validator/no-all-string-literal-unions': 'error'
-  }
-})
+    "es-spec-validator/no-all-string-literal-unions": "error",
+    "es-spec-validator/jsdoc-endpoint-check": "error",
+  },
+});

validator/eslint-plugin-es-spec.js

@@ -16,30 +16,32 @@
  * specific language governing permissions and limitations
  * under the License.
  */
-import singleKeyDict from './rules/single-key-dictionary-key-is-string.js'
-import dict from './rules/dictionary-key-is-string.js'
-import noNativeTypes from './rules/no-native-types.js'
-import invalidNodeTypes from './rules/invalid-node-types.js'
-import noGenericNumber from './rules/no-generic-number.js'
-import requestMustHaveUrls from './rules/request-must-have-urls.js'
-import noVariantsOnResponses from './rules/no-variants-on-responses.js'
-import noInlineUnions from './rules/no-inline-unions.js'
-import preferTaggedVariants from './rules/prefer-tagged-variants.js'
-import noDuplicateTypeNames from './rules/no-duplicate-type-names.js'
-import noAllStringLiteralUnions from './rules/no-all-string-literal-unions.js'
+import singleKeyDict from "./rules/single-key-dictionary-key-is-string.js";
+import dict from "./rules/dictionary-key-is-string.js";
+import noNativeTypes from "./rules/no-native-types.js";
+import invalidNodeTypes from "./rules/invalid-node-types.js";
+import noGenericNumber from "./rules/no-generic-number.js";
+import requestMustHaveUrls from "./rules/request-must-have-urls.js";
+import noVariantsOnResponses from "./rules/no-variants-on-responses.js";
+import noInlineUnions from "./rules/no-inline-unions.js";
+import preferTaggedVariants from "./rules/prefer-tagged-variants.js";
+import noDuplicateTypeNames from "./rules/no-duplicate-type-names.js";
+import noAllStringLiteralUnions from "./rules/no-all-string-literal-unions.js";
+import jsdocEndpointCheck from "./rules/jsdoc-endpoint-check.js";
 
 export default {
   rules: {
-    'single-key-dictionary-key-is-string': singleKeyDict,
-    'dictionary-key-is-string': dict,
-    'no-native-types': noNativeTypes,
-    'invalid-node-types': invalidNodeTypes,
-    'no-generic-number': noGenericNumber,
-    'request-must-have-urls': requestMustHaveUrls,
-    'no-variants-on-responses': noVariantsOnResponses,
-    'no-inline-unions': noInlineUnions,
-    'prefer-tagged-variants': preferTaggedVariants,
-    'no-duplicate-type-names': noDuplicateTypeNames,
-    'no-all-string-literal-unions': noAllStringLiteralUnions
-  }
-}
+    "single-key-dictionary-key-is-string": singleKeyDict,
+    "dictionary-key-is-string": dict,
+    "no-native-types": noNativeTypes,
+    "invalid-node-types": invalidNodeTypes,
+    "no-generic-number": noGenericNumber,
+    "request-must-have-urls": requestMustHaveUrls,
+    "no-variants-on-responses": noVariantsOnResponses,
+    "no-inline-unions": noInlineUnions,
+    "prefer-tagged-variants": preferTaggedVariants,
+    "no-duplicate-type-names": noDuplicateTypeNames,
+    "no-all-string-literal-unions": noAllStringLiteralUnions,
+    "jsdoc-endpoint-check": jsdocEndpointCheck,
+  },
+};