diff --git a/docs/overlays/elasticsearch-openapi-overlays.yaml b/docs/overlays/elasticsearch-openapi-overlays.yaml index f05eef369e..4fb3f2a901 100644 --- a/docs/overlays/elasticsearch-openapi-overlays.yaml +++ b/docs/overlays/elasticsearch-openapi-overlays.yaml @@ -40,4 +40,190 @@ actions: examples: resetFeaturesResponseExample1: $ref: "../../specification/features/reset_features/ResetFeaturesResponseExample1.json" - \ No newline at end of file + - target: "$.components['requestBodies']['cluster.allocation_explain']" + description: "Add examples for cluster allocation explain operation" + update: + content: + application/json: + examples: + clusterAllocationExplainRequestExample1: + $ref: "../../specification/cluster/allocation_explain/clusterAllocationExplainRequestExample1.json" + - target: "$.components['responses']['cluster.health#200']" + description: "Add examples for cluster health operation" + update: + content: + application/json: + examples: + clusterHealthResponseExample1: + $ref: "../../specification/cluster/health/clusterHealthResponseExample1.json" + - target: "$.paths['/_cluster/settings']['put']" + description: "Add examples for cluster update settings operation" + update: + requestBody: + content: + application/json: + examples: + clusterPutSettingsRequestExample1: + $ref: "../../specification/cluster/put_settings/clusterPutSettingsRequestExample1.json" + - target: "$.paths['/_cluster/reroute']['post']" + description: "Add examples for cluster reroute operation" + update: + requestBody: + content: + application/json: + examples: + clusterRerouteRequestExample1: + $ref: "../../specification/cluster/reroute/clusterRerouteRequestExample1.json" + - target: "$.components['requestBodies']['nodes.reload_secure_settings']" + description: "Add examples for nodes reload secure settings operation" + update: + content: + application/json: + examples: + clusterNodesReloadSecureSettingsRequestExample1: + $ref: "../../specification/nodes/reload_secure_settings/clusterNodesReloadSecureSettingsRequestExample1.json" + - target: "$.components['responses']['nodes.reload_secure_settings#200']" + description: "Add response examples for nodes reload secure settings operation" + update: + content: + application/json: + examples: + clusterNodesReloadSecureSettingsResponseExample1: + $ref: "../../specification/nodes/reload_secure_settings/clusterNodesReloadSecureSettingsResponseExample1.json" + - target: "$.paths['/_tasks']['get']" + description: "Add examples for task management operation" + update: + responses: + 200: + content: + application/json: + examples: + getTasksResponseExample1: + $ref: "../../specification/tasks/get/getTasksResponseExample1.json" + - target: "$.components['responses']['nodes.info#200']" + description: "Add response examples for nodes info" + update: + content: + application/json: + examples: + nodesInfoResponseExample1: + $ref: "../../specification/nodes/info/nodesInfoResponseExample1.yaml" + - target: "$.paths['/_ilm/policy/{policy}']['delete']" + description: "Add examples for delete lifecycle policy operation" + update: + responses: + 200: + content: + application/json: + examples: + deleteLifecycleResponseExample1: + $ref: "../../specification/ilm/delete_lifecycle/DeleteLifecycleResponseExample1.json" + - target: "$.paths['/_ilm/policy/{policy}']['put']" + description: "Add examples for create a lifecycle operation" + update: + update: + requestBody: + content: + application/json: + examples: + putLifecycleRequestExample1: + $ref: "../../specification/ilm/put_lifecycle/PutLifecycleRequestExample1.json" + responses: + 200: + content: + application/json: + examples: + putLifecycleResponseExample1: + $ref: "../../specification/ilm/put_lifecycle/PutLifecycleResponseExample1.json" + - target: "$.components['responses']['ilm.get_lifecycle#200']" + description: "Add examples for get lifecycle policy operation" + update: + content: + application/json: + examples: + getLifecycleResponseExample1: + $ref: "../../specification/ilm/get_lifecycle/GetLifecycleResponseExample1.json" + - target: "$.paths['/_ilm/migrate_to_data_tiers']['post']" + description: "Add examples for migrate to data tiers routing operation" + update: + update: + requestBody: + content: + application/json: + examples: + migrateToDataTiersRequestExample1: + $ref: "../../specification/ilm/migrate_to_data_tiers/MigrateToDataTiersRequestExample1.json" + responses: + 200: + content: + application/json: + examples: + migrateToDataTiersResponseExample1: + $ref: "../../specification/ilm/migrate_to_data_tiers/MigrateToDataTiersResponseExample1.json" + - target: "$.paths['/_ilm/move/{index}']['post']" + description: "Add examples for move to lifecycle step operation" + update: + update: + requestBody: + content: + application/json: + examples: + moveToStepRequestExample1: + $ref: "../../specification/ilm/move_to_step/MoveToStepRequestExample1.json" + responses: + 200: + content: + application/json: + examples: + moveToStepResponseExample1: + $ref: "../../specification/ilm/move_to_step/MoveToStepResponseExample1.json" + - target: "$.paths['/_ilm/start']['post']" + description: "Add examples for start index lifecycle management operation" + update: + responses: + 200: + content: + application/json: + examples: + startILMResponseExample1: + $ref: "../../specification/ilm/start/StartILMResponseExample1.json" + - target: "$.paths['/_ilm/stop']['post']" + description: "Add examples for stop index lifecycle management operation" + update: + responses: + 200: + content: + application/json: + examples: + stopILMResponseExample1: + $ref: "../../specification/ilm/stop/stopILMResponseExample1.json" + - target: "$.paths['/_ilm/status']['get']" + description: "Add examples for get index lifecycle management status operation" + update: + responses: + 200: + content: + application/json: + examples: + getILMStatusResponseExample1: + $ref: "../../specification/ilm/get_status/GetILMStatusResponseExample1.json" + - target: "$.paths['/{index}/_ilm/explain']['get']" + description: "Add examples for explain lifecycle operation" + update: + responses: + 200: + content: + application/json: + examples: + explainLifecycleResponseExample1: + $ref: "../../specification/ilm/explain_lifecycle/ExplainLifecycleResponseExample1.json" + - target: "$.paths['/{index}/_ilm/remove']['post']" + description: "Add examples for remove policy from index operation" + update: + responses: + 200: + content: + application/json: + examples: + removePolicyResponseExample1: + $ref: "../../specification/ilm/remove_policy/RemovePolicyResponseExample1.json" diff --git a/docs/overlays/elasticsearch-shared-example-overlays.yaml b/docs/overlays/elasticsearch-shared-example-overlays.yaml index 538bc5a86b..11ca8f7182 100644 --- a/docs/overlays/elasticsearch-shared-example-overlays.yaml +++ b/docs/overlays/elasticsearch-shared-example-overlays.yaml @@ -107,3 +107,11 @@ actions: examples: esqlQueryRequestExample1: $ref: "../../specification/esql/query/EsqlQueryApiRequestExample1.json" + - target: "$.components['requestBodies']['graph.explore']" + description: "Add example for graph explore request" + update: + content: + application/json: + examples: + graphExploreRequestExample1: + $ref: "../../specification/graph/explore/graphExploreRequestExample1.json" \ No newline at end of file diff --git a/package-lock.json b/package-lock.json index 1207f474d5..ce43361727 100644 --- a/package-lock.json +++ b/package-lock.json @@ -5,13 +5,14 @@ "packages": { "": { "dependencies": { - "@stoplight/spectral-cli": "^6.11.1" + "@stoplight/spectral-cli": "^6.13.0" } }, "node_modules/@asyncapi/specs": { "version": "4.3.1", "resolved": "https://registry.npmjs.org/@asyncapi/specs/-/specs-4.3.1.tgz", "integrity": "sha512-EfexhJu/lwF8OdQDm28NKLJHFkx0Gb6O+rcezhZYLPIoNYKXJMh2J1vFGpwmfAcTTh+ffK44Oc2Hs1Q4sLBp+A==", + "license": "Apache-2.0", "dependencies": { "@types/json-schema": "^7.0.11" } @@ -74,6 +75,7 @@ "version": "22.0.2", "resolved": "https://registry.npmjs.org/@rollup/plugin-commonjs/-/plugin-commonjs-22.0.2.tgz", "integrity": "sha512-//NdP6iIwPbMTcazYsiBMbJW7gfmpHom33u1beiIoHDEM0Q9clvtQB1T0efvMqHeKsGohiHo97BCPCkBXdscwg==", + "license": "MIT", "dependencies": { "@rollup/pluginutils": "^3.1.0", "commondir": "^1.0.1", @@ -94,6 +96,7 @@ "version": "3.1.0", "resolved": "https://registry.npmjs.org/@rollup/pluginutils/-/pluginutils-3.1.0.tgz", "integrity": "sha512-GksZ6pr6TpIjHm8h9lSQ8pi8BE9VeubNT0OMJ3B5uZJ8pz73NPiqOtCog/x2/QzM1ENChPKxMDhiQuRHsqc+lg==", + "license": "MIT", "dependencies": { "@types/estree": "0.0.39", "estree-walker": "^1.0.1", @@ -109,7 +112,8 @@ "node_modules/@rollup/pluginutils/node_modules/estree-walker": { "version": "1.0.1", "resolved": "https://registry.npmjs.org/estree-walker/-/estree-walker-1.0.1.tgz", - "integrity": "sha512-1fMXF3YP4pZZVozF8j/ZLfvnR8NSIljt56UhbZ5PeeDmmGHpgpdwQt7ITlGvYaQukCvuBRMLEiKiYC+oeIg4cg==" + "integrity": "sha512-1fMXF3YP4pZZVozF8j/ZLfvnR8NSIljt56UhbZ5PeeDmmGHpgpdwQt7ITlGvYaQukCvuBRMLEiKiYC+oeIg4cg==", + "license": "MIT" }, "node_modules/@stoplight/better-ajv-errors": { "version": "1.0.3", @@ -196,9 +200,9 @@ } }, "node_modules/@stoplight/spectral-cli": { - "version": "6.11.1", - "resolved": "https://registry.npmjs.org/@stoplight/spectral-cli/-/spectral-cli-6.11.1.tgz", - "integrity": "sha512-1zqsQ0TOuVSnxxZ9mHBfC0IygV6ex7nAY6Mp59mLmw5fW103U9yPVK5ZcX9ZngCmr3PdteAnMDUIIaoDGso6nA==", + "version": "6.13.0", + "resolved": "https://registry.npmjs.org/@stoplight/spectral-cli/-/spectral-cli-6.13.0.tgz", + "integrity": "sha512-qofxmVN4czNNJdfq0OB8Qj1ihpIhyR0IgyQpJFda9FvWWn9vJqDuIsoGKWP7xIHwv3E31q3iviDIX3Ejy9tNcg==", "license": "Apache-2.0", "dependencies": { "@stoplight/json": "~3.21.0", @@ -207,8 +211,8 @@ "@stoplight/spectral-formatters": "^1.3.0", "@stoplight/spectral-parsers": "^1.0.3", "@stoplight/spectral-ref-resolver": "^1.0.4", - "@stoplight/spectral-ruleset-bundler": "^1.5.2", - "@stoplight/spectral-ruleset-migrator": "^1.9.5", + "@stoplight/spectral-ruleset-bundler": "^1.5.4", + "@stoplight/spectral-ruleset-migrator": "^1.9.6", "@stoplight/spectral-rulesets": ">=1", "@stoplight/spectral-runtime": "^1.1.2", "@stoplight/types": "^13.6.0", @@ -272,9 +276,10 @@ } }, "node_modules/@stoplight/spectral-formats": { - "version": "1.6.0", - "resolved": "https://registry.npmjs.org/@stoplight/spectral-formats/-/spectral-formats-1.6.0.tgz", - "integrity": "sha512-X27qhUfNluiduH0u/QwJqhOd8Wk5YKdxVmKM03Aijlx0AH1H5mYt3l9r7t2L4iyJrsBaFPnMGt7UYJDGxszbNA==", + "version": "1.7.0", + "resolved": "https://registry.npmjs.org/@stoplight/spectral-formats/-/spectral-formats-1.7.0.tgz", + "integrity": "sha512-vJ1vIkA2s96fdJp0d3AJBGuPAW3sj8yMamyzR+dquEFO6ZAoYBo/BVsKKQskYzZi/nwljlRqUmGVmcf2PncIaA==", + "license": "Apache-2.0", "dependencies": { "@stoplight/json": "^3.17.0", "@stoplight/spectral-core": "^1.8.0", @@ -307,16 +312,17 @@ } }, "node_modules/@stoplight/spectral-functions": { - "version": "1.8.0", - "resolved": "https://registry.npmjs.org/@stoplight/spectral-functions/-/spectral-functions-1.8.0.tgz", - "integrity": "sha512-ZrAkYA/ZGbuQ6EyG1gisF4yQ5nWP/+glcqVoGmS6kH6ekaynz2Yp6FL0oIamWj3rWedFUN7ppwTRUdo+9f/uCw==", + "version": "1.9.0", + "resolved": "https://registry.npmjs.org/@stoplight/spectral-functions/-/spectral-functions-1.9.0.tgz", + "integrity": "sha512-T+xl93ji8bpus4wUsTq8Qr2DSu2X9PO727rbxW61tTCG0s17CbsXOLYI+Ezjg5P6aaQlgXszGX8khtc57xk8Yw==", + "license": "Apache-2.0", "dependencies": { "@stoplight/better-ajv-errors": "1.0.3", "@stoplight/json": "^3.17.1", "@stoplight/spectral-core": "^1.7.0", - "@stoplight/spectral-formats": "^1.0.0", + "@stoplight/spectral-formats": "^1.7.0", "@stoplight/spectral-runtime": "^1.1.0", - "ajv": "^8.6.3", + "ajv": "^8.17.1", "ajv-draft-04": "~1.0.0", "ajv-errors": "~3.0.0", "ajv-formats": "~2.1.0", @@ -369,18 +375,19 @@ } }, "node_modules/@stoplight/spectral-ruleset-bundler": { - "version": "1.5.2", - "resolved": "https://registry.npmjs.org/@stoplight/spectral-ruleset-bundler/-/spectral-ruleset-bundler-1.5.2.tgz", - "integrity": "sha512-4QUVUFAU+S7IQ9XeCu+0TQMYxKFpKnkOAfa9unRQ1iPL2cviaipEN6witpbAptdHJD3UUjx4OnwlX8WwmXSq9w==", + "version": "1.6.0", + "resolved": "https://registry.npmjs.org/@stoplight/spectral-ruleset-bundler/-/spectral-ruleset-bundler-1.6.0.tgz", + "integrity": "sha512-8CU7e4aEGdfU9ncVDtlnJSawg/6epzAHrQTjuNu1QfKAOoiwyG7oUk2XUTHWcvq6Q67iUctb0vjOokR+MPVg0Q==", + "license": "Apache-2.0", "dependencies": { "@rollup/plugin-commonjs": "~22.0.2", "@stoplight/path": "1.3.2", "@stoplight/spectral-core": ">=1", - "@stoplight/spectral-formats": ">=1", + "@stoplight/spectral-formats": "^1.7.0", "@stoplight/spectral-functions": ">=1", "@stoplight/spectral-parsers": ">=1", - "@stoplight/spectral-ref-resolver": ">=1", - "@stoplight/spectral-ruleset-migrator": "^1.7.4", + "@stoplight/spectral-ref-resolver": "^1.0.4", + "@stoplight/spectral-ruleset-migrator": "^1.9.6", "@stoplight/spectral-rulesets": ">=1", "@stoplight/spectral-runtime": "^1.1.0", "@stoplight/types": "^13.6.0", @@ -395,9 +402,10 @@ } }, "node_modules/@stoplight/spectral-ruleset-migrator": { - "version": "1.9.5", - "resolved": "https://registry.npmjs.org/@stoplight/spectral-ruleset-migrator/-/spectral-ruleset-migrator-1.9.5.tgz", - "integrity": "sha512-76n/HETr3UinVl/xLNldrH9p0JNoD8Gz4K75J6E4OHp4xD0P+BA2e8+W30HjIvqm1LJdLU2BNma0ioy+q3B9RA==", + "version": "1.10.0", + "resolved": "https://registry.npmjs.org/@stoplight/spectral-ruleset-migrator/-/spectral-ruleset-migrator-1.10.0.tgz", + "integrity": "sha512-nDfkVfYeWWv0UvILC4TWZSnRqQ4rHgeOJO1/lHQ7XHeG5iONanQ639B1aK6ZS6vuUc8gwuyQsrPF67b4sHIyYw==", + "license": "Apache-2.0", "dependencies": { "@stoplight/json": "~3.21.0", "@stoplight/ordered-object-literal": "~1.0.4", @@ -407,7 +415,7 @@ "@stoplight/types": "^13.6.0", "@stoplight/yaml": "~4.2.3", "@types/node": "*", - "ajv": "^8.6.0", + "ajv": "^8.17.1", "ast-types": "0.14.2", "astring": "^1.7.5", "reserved": "0.1.2", @@ -422,6 +430,7 @@ "version": "4.2.3", "resolved": "https://registry.npmjs.org/@stoplight/yaml/-/yaml-4.2.3.tgz", "integrity": "sha512-Mx01wjRAR9C7yLMUyYFTfbUf5DimEpHMkRDQ1PKLe9dfNILbgdxyrncsOXM3vCpsQ1Hfj4bPiGl+u4u6e9Akqw==", + "license": "Apache-2.0", "dependencies": { "@stoplight/ordered-object-literal": "^1.0.1", "@stoplight/types": "^13.0.0", @@ -435,23 +444,25 @@ "node_modules/@stoplight/spectral-ruleset-migrator/node_modules/@stoplight/yaml-ast-parser": { "version": "0.0.48", "resolved": "https://registry.npmjs.org/@stoplight/yaml-ast-parser/-/yaml-ast-parser-0.0.48.tgz", - "integrity": "sha512-sV+51I7WYnLJnKPn2EMWgS4EUfoP4iWEbrWwbXsj0MZCB/xOK8j6+C9fntIdOM50kpx45ZLC3s6kwKivWuqvyg==" + "integrity": "sha512-sV+51I7WYnLJnKPn2EMWgS4EUfoP4iWEbrWwbXsj0MZCB/xOK8j6+C9fntIdOM50kpx45ZLC3s6kwKivWuqvyg==", + "license": "Apache-2.0" }, "node_modules/@stoplight/spectral-rulesets": { - "version": "1.19.1", - "resolved": "https://registry.npmjs.org/@stoplight/spectral-rulesets/-/spectral-rulesets-1.19.1.tgz", - "integrity": "sha512-rfGK87Y1JJCEeLC8MVdLkjUkRH+Y6VnSF388D+UWihfU9xuq2eNB9phWpTFkG+AG4HLRyGx963BmO6PyM9dBag==", + "version": "1.20.2", + "resolved": "https://registry.npmjs.org/@stoplight/spectral-rulesets/-/spectral-rulesets-1.20.2.tgz", + "integrity": "sha512-7Y8orZuNyGyeHr9n50rMfysgUJ+/zzIEHMptt66jiy82GUWl+0nr865DkMuXdC5GryfDYhtjoRTUCVsXu80Nkg==", + "license": "Apache-2.0", "dependencies": { "@asyncapi/specs": "^4.1.0", "@stoplight/better-ajv-errors": "1.0.3", "@stoplight/json": "^3.17.0", "@stoplight/spectral-core": "^1.8.1", - "@stoplight/spectral-formats": "^1.5.0", + "@stoplight/spectral-formats": "^1.7.0", "@stoplight/spectral-functions": "^1.5.1", "@stoplight/spectral-runtime": "^1.1.1", "@stoplight/types": "^13.6.0", "@types/json-schema": "^7.0.7", - "ajv": "^8.12.0", + "ajv": "^8.17.1", "ajv-formats": "~2.1.0", "json-schema-traverse": "^1.0.0", "leven": "3.1.0", @@ -545,7 +556,8 @@ "node_modules/@types/estree": { "version": "0.0.39", "resolved": "https://registry.npmjs.org/@types/estree/-/estree-0.0.39.tgz", - "integrity": "sha512-EYNwp3bU+98cpU4lAWYYL7Zz+2gryWH1qbdDTidVd6hkiR6weksdbMadyXKXNPEkQFhXM+hVO9ZygomHXp+AIw==" + "integrity": "sha512-EYNwp3bU+98cpU4lAWYYL7Zz+2gryWH1qbdDTidVd6hkiR6weksdbMadyXKXNPEkQFhXM+hVO9ZygomHXp+AIw==", + "license": "MIT" }, "node_modules/@types/json-schema": { "version": "7.0.15", @@ -582,14 +594,15 @@ } }, "node_modules/ajv": { - "version": "8.16.0", - "resolved": "https://registry.npmjs.org/ajv/-/ajv-8.16.0.tgz", - "integrity": "sha512-F0twR8U1ZU67JIEtekUcLkXkoO5mMMmgGD8sK/xUFzJ805jxHQl92hImFAqqXMyMYjSPOyUPAwHYhB72g5sTXw==", + "version": "8.17.1", + "resolved": "https://registry.npmjs.org/ajv/-/ajv-8.17.1.tgz", + "integrity": "sha512-B/gBuNg5SiMTrPkC+A2+cW0RszwxYmn6VYxB/inlBStS5nx6xHIt/ehKRhIMhqusl7a8LjQoZnjCs5vhwxOQ1g==", + "license": "MIT", "dependencies": { "fast-deep-equal": "^3.1.3", + "fast-uri": "^3.0.1", "json-schema-traverse": "^1.0.0", - "require-from-string": "^2.0.2", - "uri-js": "^4.4.1" + "require-from-string": "^2.0.2" }, "funding": { "type": "github", @@ -600,6 +613,7 @@ "version": "1.0.0", "resolved": "https://registry.npmjs.org/ajv-draft-04/-/ajv-draft-04-1.0.0.tgz", "integrity": "sha512-mv00Te6nmYbRp5DCwclxtt7yV/joXJPGS7nM+97GdxvuttCOfgI3K4U25zboyeX0O+myI8ERluxQe5wljMmVIw==", + "license": "MIT", "peerDependencies": { "ajv": "^8.5.0" }, @@ -703,6 +717,7 @@ "version": "0.14.2", "resolved": "https://registry.npmjs.org/ast-types/-/ast-types-0.14.2.tgz", "integrity": "sha512-O0yuUDnZeQDL+ncNGlJ78BiO4jnYI3bvMsD5prT0/nsgijG/LpNBIr63gTjVTNsiGkgQhiyCShTgxt8oXOrklA==", + "license": "MIT", "dependencies": { "tslib": "^2.0.1" }, @@ -760,7 +775,8 @@ "node_modules/builtins": { "version": "1.0.3", "resolved": "https://registry.npmjs.org/builtins/-/builtins-1.0.3.tgz", - "integrity": "sha512-uYBjakWipfaO/bXI7E8rq6kpwHRZK5cNYrUv2OzZSI/FvmdMyXJ2tG9dKcjEC5YHmHpUAwsargWIZNWdxb/bnQ==" + "integrity": "sha512-uYBjakWipfaO/bXI7E8rq6kpwHRZK5cNYrUv2OzZSI/FvmdMyXJ2tG9dKcjEC5YHmHpUAwsargWIZNWdxb/bnQ==", + "license": "MIT" }, "node_modules/call-bind": { "version": "1.0.7", @@ -824,7 +840,8 @@ "node_modules/commondir": { "version": "1.0.1", "resolved": "https://registry.npmjs.org/commondir/-/commondir-1.0.1.tgz", - "integrity": "sha512-W9pAhw0ja1Edb5GVdIF1mjZw/ASI0AlShXM83UUGe2DVr5TdAPEA1OA8m/g8zWp9x6On7gqufY+FatDbC3MDQg==" + "integrity": "sha512-W9pAhw0ja1Edb5GVdIF1mjZw/ASI0AlShXM83UUGe2DVr5TdAPEA1OA8m/g8zWp9x6On7gqufY+FatDbC3MDQg==", + "license": "MIT" }, "node_modules/concat-map": { "version": "0.0.1", @@ -1079,7 +1096,8 @@ "node_modules/estree-walker": { "version": "2.0.2", "resolved": "https://registry.npmjs.org/estree-walker/-/estree-walker-2.0.2.tgz", - "integrity": "sha512-Rfkk/Mp/DL7JVje3u18FxFujQlTNR2q6QfMSMB7AvCBx91NGj/ba3kCfza0f6dVDbw7YlRf/nDrn7pQrCCyQ/w==" + "integrity": "sha512-Rfkk/Mp/DL7JVje3u18FxFujQlTNR2q6QfMSMB7AvCBx91NGj/ba3kCfza0f6dVDbw7YlRf/nDrn7pQrCCyQ/w==", + "license": "MIT" }, "node_modules/event-target-shim": { "version": "5.0.1", @@ -1114,6 +1132,12 @@ "resolved": "https://registry.npmjs.org/fast-memoize/-/fast-memoize-2.5.2.tgz", "integrity": "sha512-Ue0LwpDYErFbmNnZSF0UH6eImUwDmogUO1jyE+JbN2gsQz/jICm1Ve7t9QT0rNSsfJt+Hs4/S3GnsDVjL4HVrw==" }, + "node_modules/fast-uri": { + "version": "3.0.1", + "resolved": "https://registry.npmjs.org/fast-uri/-/fast-uri-3.0.1.tgz", + "integrity": "sha512-MWipKbbYiYI0UC7cl8m/i/IWTqfC8YXsqjzybjddLsFjStroQzsHXkc73JutMvBiXmOvapk+axIl79ig5t55Bw==", + "license": "MIT" + }, "node_modules/fastq": { "version": "1.17.1", "resolved": "https://registry.npmjs.org/fastq/-/fastq-1.17.1.tgz", @@ -1157,7 +1181,22 @@ "node_modules/fs.realpath": { "version": "1.0.0", "resolved": "https://registry.npmjs.org/fs.realpath/-/fs.realpath-1.0.0.tgz", - "integrity": "sha512-OO0pH2lK6a0hZnAdau5ItzHPI6pUlvI7jMVnxUQRtw4owF2wk8lOSabtGDCTP4Ggrg2MbGnWO9X8K1t4+fGMDw==" + "integrity": "sha512-OO0pH2lK6a0hZnAdau5ItzHPI6pUlvI7jMVnxUQRtw4owF2wk8lOSabtGDCTP4Ggrg2MbGnWO9X8K1t4+fGMDw==", + "license": "ISC" + }, + "node_modules/fsevents": { + "version": "2.3.3", + "resolved": "https://registry.npmjs.org/fsevents/-/fsevents-2.3.3.tgz", + "integrity": "sha512-5xoDfX+fL7faATnagmWPpbFtwh/R77WmMMqqHGS65C3vvB0YHrgF+B1YmZ3441tMj5n63k0212XNoJwzlhffQw==", + "hasInstallScript": true, + "license": "MIT", + "optional": true, + "os": [ + "darwin" + ], + "engines": { + "node": "^8.16.0 || ^10.6.0 || >=11.0.0" + } }, "node_modules/function-bind": { "version": "1.1.2", @@ -1248,6 +1287,7 @@ "resolved": "https://registry.npmjs.org/glob/-/glob-7.2.3.tgz", "integrity": "sha512-nFR0zLpU2YCaRxwoCJvL6UvCH2JFyFVIvwTLsIf21AuHlMskA1hhTdk+LlYJtOlYt9v6dvszD2BGRqBL+iQK9Q==", "deprecated": "Glob versions prior to v9 are no longer supported", + "license": "ISC", "dependencies": { "fs.realpath": "^1.0.0", "inflight": "^1.0.4", @@ -1401,6 +1441,7 @@ "resolved": "https://registry.npmjs.org/inflight/-/inflight-1.0.6.tgz", "integrity": "sha512-k92I/b08q4wvFscXCLvqfsHCrjrF7yiXsQuIVvVE7N82W3+aqpzuUdBbfhWcy/FZR3/4IgflMgKLOsvPDrGCJA==", "deprecated": "This module is not supported, and leaks memory. Do not use it. Check out lru-cache if you want a good and tested way to coalesce async requests by a key value, which is much more comprehensive and powerful.", + "license": "ISC", "dependencies": { "once": "^1.3.0", "wrappy": "1" @@ -1409,7 +1450,8 @@ "node_modules/inherits": { "version": "2.0.4", "resolved": "https://registry.npmjs.org/inherits/-/inherits-2.0.4.tgz", - "integrity": "sha512-k/vGaX4/Yla3WzyMCvTQOXYeIHvqOKtnqBduzTHpzpQZzAskKMhZ2K+EnBiSM9zGSoIFeMpXKxa4dYeZIQqewQ==" + "integrity": "sha512-k/vGaX4/Yla3WzyMCvTQOXYeIHvqOKtnqBduzTHpzpQZzAskKMhZ2K+EnBiSM9zGSoIFeMpXKxa4dYeZIQqewQ==", + "license": "ISC" }, "node_modules/internal-slot": { "version": "1.0.7", @@ -1477,9 +1519,10 @@ } }, "node_modules/is-core-module": { - "version": "2.14.0", - "resolved": "https://registry.npmjs.org/is-core-module/-/is-core-module-2.14.0.tgz", - "integrity": "sha512-a5dFJih5ZLYlRtDc0dZWP7RiKr6xIKzmn/oAYCDvdLThadVgyJwlaoQPmRtMSpz+rk0OGAgIu+TcM9HUF0fk1A==", + "version": "2.15.1", + "resolved": "https://registry.npmjs.org/is-core-module/-/is-core-module-2.15.1.tgz", + "integrity": "sha512-z0vtXSwucUJtANQWldhbtbt7BnL0vxiFjIdDLAatwhDYty2bad6s+rijD6Ri4YuYJubLzIJLUidCh09e1djEVQ==", + "license": "MIT", "dependencies": { "hasown": "^2.0.2" }, @@ -1582,6 +1625,7 @@ "version": "1.2.1", "resolved": "https://registry.npmjs.org/is-reference/-/is-reference-1.2.1.tgz", "integrity": "sha512-U82MsXXiFIrjCK4otLT+o2NA2Cd2g5MLoOVXUZjIOhLurrRxpEXzI8O0KZHr3IjLvlAH1kTPYSuqer5T9ZVBKQ==", + "license": "MIT", "dependencies": { "@types/estree": "*" } @@ -1740,6 +1784,7 @@ "version": "0.25.9", "resolved": "https://registry.npmjs.org/magic-string/-/magic-string-0.25.9.tgz", "integrity": "sha512-RmF0AsMzgt25qzqqLc1+MbHmhdx0ojF2Fvs4XnOqz2ZOBXzzkEwc/dJQZCYHAn7v1jbVOjAZfK8msRn4BxO4VQ==", + "license": "MIT", "dependencies": { "sourcemap-codec": "^1.4.8" } @@ -1870,6 +1915,7 @@ "version": "1.4.0", "resolved": "https://registry.npmjs.org/once/-/once-1.4.0.tgz", "integrity": "sha512-lNaJgI+2Q5URQBkccEKHTQOPaXdUxnZZElQTZY0MFUAuaEqe1E+Nyvgdz/aIyNi6Z9MzO5dv1H8n58/GELp3+w==", + "license": "ISC", "dependencies": { "wrappy": "1" } @@ -1878,6 +1924,7 @@ "version": "1.0.1", "resolved": "https://registry.npmjs.org/path-is-absolute/-/path-is-absolute-1.0.1.tgz", "integrity": "sha512-AVbw3UJ2e9bq64vSaS9Am0fje1Pa8pbGqTTsmXfaIiMpnr5DlDhfJOuLj9Sf95ZPVDAUerDfEk88MPmPe7UCQg==", + "license": "MIT", "engines": { "node": ">=0.10.0" } @@ -1885,7 +1932,8 @@ "node_modules/path-parse": { "version": "1.0.7", "resolved": "https://registry.npmjs.org/path-parse/-/path-parse-1.0.7.tgz", - "integrity": "sha512-LDJzPVEEEPR+y48z93A0Ed0yXb8pAByGWo/k5YYdYgpY2/2EsOsksJrq7lOHxryrVOn1ejG6oAp8ahvOIQD8sw==" + "integrity": "sha512-LDJzPVEEEPR+y48z93A0Ed0yXb8pAByGWo/k5YYdYgpY2/2EsOsksJrq7lOHxryrVOn1ejG6oAp8ahvOIQD8sw==", + "license": "MIT" }, "node_modules/picomatch": { "version": "2.3.1", @@ -1919,14 +1967,6 @@ "resolved": "https://registry.npmjs.org/printable-characters/-/printable-characters-1.0.42.tgz", "integrity": "sha512-dKp+C4iXWK4vVYZmYSd0KBH5F/h1HoZRsbJ82AVKRO3PEo8L4lBS/vLwhVtpwwuYcoIsVY+1JYKR268yn480uQ==" }, - "node_modules/punycode": { - "version": "2.3.1", - "resolved": "https://registry.npmjs.org/punycode/-/punycode-2.3.1.tgz", - "integrity": "sha512-vYt7UD1U9Wg6138shLtLOvdAu+8DsC/ilFtEVHcH+wydcSpNE20AfSOduf6MkRFahL5FY7X1oU7nKVZFtfq8Fg==", - "engines": { - "node": ">=6" - } - }, "node_modules/queue-microtask": { "version": "1.2.3", "resolved": "https://registry.npmjs.org/queue-microtask/-/queue-microtask-1.2.3.tgz", @@ -1991,6 +2031,7 @@ "version": "1.22.8", "resolved": "https://registry.npmjs.org/resolve/-/resolve-1.22.8.tgz", "integrity": "sha512-oKWePCxqpd6FlLvGV1VU0x7bkPmmCNolxzjMf4NczoDnQcIWrAF+cPtZn5i6n+RfD2d9i0tzpKnG6Yk168yIyw==", + "license": "MIT", "dependencies": { "is-core-module": "^2.13.0", "path-parse": "^1.0.7", @@ -2016,6 +2057,7 @@ "version": "2.79.1", "resolved": "https://registry.npmjs.org/rollup/-/rollup-2.79.1.tgz", "integrity": "sha512-uKxbd0IhMZOhjAiD5oAFp7BqvkA4Dv47qpOCtaNvng4HBwdbWtdOh8f5nZNuk2rp51PMGk3bzfWu5oayNEuYnw==", + "license": "MIT", "bin": { "rollup": "dist/bin/rollup" }, @@ -2156,7 +2198,8 @@ "version": "1.4.8", "resolved": "https://registry.npmjs.org/sourcemap-codec/-/sourcemap-codec-1.4.8.tgz", "integrity": "sha512-9NykojV5Uih4lgo5So5dtw+f0JgJX30KCNI8gwhz2J9A15wD0Ml6tjHKwf6fTSa6fAdVBdZeNOs9eJ71qCk8vA==", - "deprecated": "Please use @jridgewell/sourcemap-codec instead" + "deprecated": "Please use @jridgewell/sourcemap-codec instead", + "license": "MIT" }, "node_modules/stacktracey": { "version": "2.1.8", @@ -2252,6 +2295,7 @@ "version": "1.0.0", "resolved": "https://registry.npmjs.org/supports-preserve-symlinks-flag/-/supports-preserve-symlinks-flag-1.0.0.tgz", "integrity": "sha512-ot0WnXS9fgdkgIcePe6RHNk1WA8+muPa6cSjeR3V8K27q9BB1rTE3R1p7Hv0z1ZyAc8s6Vvv8DIyWf681MAt0w==", + "license": "MIT", "engines": { "node": ">= 0.4" }, @@ -2381,14 +2425,6 @@ "node": ">= 10.0.0" } }, - "node_modules/uri-js": { - "version": "4.4.1", - "resolved": "https://registry.npmjs.org/uri-js/-/uri-js-4.4.1.tgz", - "integrity": "sha512-7rKUyy33Q1yc98pQ1DAmLtwX109F7TIfWlW1Ydo8Wl1ii1SeHieeh0HHfPeL2fMXK6z0s8ecKs9frCuLJvndBg==", - "dependencies": { - "punycode": "^2.1.0" - } - }, "node_modules/urijs": { "version": "1.19.11", "resolved": "https://registry.npmjs.org/urijs/-/urijs-1.19.11.tgz", @@ -2406,6 +2442,7 @@ "version": "3.0.0", "resolved": "https://registry.npmjs.org/validate-npm-package-name/-/validate-npm-package-name-3.0.0.tgz", "integrity": "sha512-M6w37eVCMMouJ9V/sdPGnC5H4uDr73/+xdq0FBLO3TFFX1+7wiUY6Es328NN+y43tmY+doUdN9g9J21vqB7iLw==", + "license": "ISC", "dependencies": { "builtins": "^1.0.3" } @@ -2476,7 +2513,8 @@ "node_modules/wrappy": { "version": "1.0.2", "resolved": "https://registry.npmjs.org/wrappy/-/wrappy-1.0.2.tgz", - "integrity": "sha512-l4Sp/DRseor9wL6EvV2+TuQn63dMkPjZ/sp9XkghTEbV9KlPS1xUsZ3u7/IQO4wxtcFB4bgpQPRcR3QCvezPcQ==" + "integrity": "sha512-l4Sp/DRseor9wL6EvV2+TuQn63dMkPjZ/sp9XkghTEbV9KlPS1xUsZ3u7/IQO4wxtcFB4bgpQPRcR3QCvezPcQ==", + "license": "ISC" }, "node_modules/y18n": { "version": "5.0.8", diff --git a/package.json b/package.json index 91d8dd23da..e936d7f831 100644 --- a/package.json +++ b/package.json @@ -1,5 +1,5 @@ { "dependencies": { - "@stoplight/spectral-cli": "^6.11.1" + "@stoplight/spectral-cli": "^6.13.0" } } diff --git a/specification/graph/explore/graphExploreRequestExample1.json b/specification/graph/explore/graphExploreRequestExample1.json new file mode 100644 index 0000000000..2d0a7f7632 --- /dev/null +++ b/specification/graph/explore/graphExploreRequestExample1.json @@ -0,0 +1,7 @@ +{ + "summary": "An initial graph explore query to identify strongly related terms.", + "method_request": "POST clicklogs/_graph/explore", + "description": "", + "type": "request", + "value": "{\n \"query\": {\n \"match\": {\n \"query.raw\": \"midi\"\n }\n },\n \"vertices\": [\n {\n \"field\": \"product\"\n }\n ],\n \"connections\": {\n \"vertices\": [\n {\n \"field\": \"query.raw\"\n }\n ]\n }\n}" +} diff --git a/specification/ilm/delete_lifecycle/DeleteLifecycleResponseExample1.json b/specification/ilm/delete_lifecycle/DeleteLifecycleResponseExample1.json new file mode 100644 index 0000000000..e1475de8c1 --- /dev/null +++ b/specification/ilm/delete_lifecycle/DeleteLifecycleResponseExample1.json @@ -0,0 +1,7 @@ +{ + "summary": "A successful response when deleting a lifecycle policy.", + "description": "", + "type": "response", + "response_code": 200, + "value": "{\n \"acknowledged\": true\n}" +} diff --git a/specification/ilm/explain_lifecycle/ExplainLifecycleResponseExample1.json b/specification/ilm/explain_lifecycle/ExplainLifecycleResponseExample1.json new file mode 100644 index 0000000000..88df4c82b3 --- /dev/null +++ b/specification/ilm/explain_lifecycle/ExplainLifecycleResponseExample1.json @@ -0,0 +1,7 @@ +{ + "summary": "A successful response when retrieving the current ILM status for an index.", + "description": "", + "type": "response", + "response_code": 200, + "value": "{\n \"indices\": {\n \"my-index-000001\": {\n \"index\": \"my-index-000001\",\n \"index_creation_date_millis\": 1538475653281,\n \"index_creation_date\": \"2018-10-15T13:45:21.981Z\",\n \"time_since_index_creation\": \"15s\",\n \"managed\": true,\n \"policy\": \"my_policy\",\n \"lifecycle_date_millis\": 1538475653281,\n \"lifecycle_date\": \"2018-10-15T13:45:21.981Z\",\n \"age\": \"15s\",\n \"phase\": \"new\",\n \"phase_time_millis\": 1538475653317,\n \"phase_time\": \"2018-10-15T13:45:22.577Z\",\n \"action\": \"complete\"\n \"action_time_millis\": 1538475653317,\n \"action_time\": \"2018-10-15T13:45:22.577Z\",\n \"step\": \"complete\",\n \"step_time_millis\": 1538475653317,\n \"step_time\": \"2018-10-15T13:45:22.577Z\"\n }\n }\n}" +} diff --git a/specification/ilm/get_lifecycle/GetLifecycleResponseExample1.json b/specification/ilm/get_lifecycle/GetLifecycleResponseExample1.json new file mode 100644 index 0000000000..a532955ccd --- /dev/null +++ b/specification/ilm/get_lifecycle/GetLifecycleResponseExample1.json @@ -0,0 +1,7 @@ +{ + "summary": "A successful response when retrieving a lifecycle policy.", + "description": "", + "type": "response", + "response_code": 200, + "value": "{\n \"my_policy\": {\n \"version\": 1,\n \"modified_date\": 82392349,\n \"policy\": {\n \"phases\": {\n \"warm\": {\n \"min_age\": \"10d\",\n \"actions\": {\n \"forcemerge\": {\n \"max_num_segments\": 1\n }\n }\n },\n \"delete\": {\n \"min_age\": \"30d\",\n \"actions\": {\n \"delete\": {\n \"delete_searchable_snapshot\": true\n }\n }\n }\n }\n },\n \"in_use_by\" : {\n \"indices\" : [],\n \"data_streams\" : [],\n \"composable_templates\" : []\n }\n }\n}" +} diff --git a/specification/ilm/get_status/GetILMStatusResponseExample1.json b/specification/ilm/get_status/GetILMStatusResponseExample1.json new file mode 100644 index 0000000000..6625442df4 --- /dev/null +++ b/specification/ilm/get_status/GetILMStatusResponseExample1.json @@ -0,0 +1,7 @@ +{ + "summary": "A successful response when retrieving the current ILM status.", + "description": "", + "type": "response", + "response_code": 200, + "value": "{\n \"operation_mode\": \"RUNNING\"\n}" +} diff --git a/specification/ilm/migrate_to_data_tiers/MigrateToDataTiersRequestExample1.json b/specification/ilm/migrate_to_data_tiers/MigrateToDataTiersRequestExample1.json new file mode 100644 index 0000000000..d9c927ccbc --- /dev/null +++ b/specification/ilm/migrate_to_data_tiers/MigrateToDataTiersRequestExample1.json @@ -0,0 +1,7 @@ +{ + "summary": "Migrates indices, ILM policies, and templates from using custom node attributes to using data tiers.", + "method_request": "POST /_ilm/migrate_to_data_tiers", + "description": "The example migrates the indices, ILM policies, legacy templates, composable, and component templates away from defining custom allocation filtering using the custom_attribute_name node attribute, and deletes the legacy template with name global-template if it exists in the system.", + "type": "request", + "value": "{\n \"legacy_template_to_delete\": \"global-template\",\n \"node_attribute\": \"custom_attribute_name\"\n}" +} diff --git a/specification/ilm/migrate_to_data_tiers/MigrateToDataTiersResponseExample1.json b/specification/ilm/migrate_to_data_tiers/MigrateToDataTiersResponseExample1.json new file mode 100644 index 0000000000..967358c543 --- /dev/null +++ b/specification/ilm/migrate_to_data_tiers/MigrateToDataTiersResponseExample1.json @@ -0,0 +1,7 @@ +{ + "summary": "A successful response when migrating indices, ILMs, and templates from custom node attributes to data tiers.", + "description": "", + "type": "response", + "response_code": 200, + "value": "{\n \"dry_run\": false,\n \"removed_legacy_template\":\"global-template\",\n \"migrated_ilm_policies\":[\"policy_with_allocate_action\"],\n \"migrated_indices\":[\"warm-index-to-migrate-000001\"],\n \"migrated_legacy_templates\":[\"a-legacy-template\"],\n \"migrated_composable_templates\":[\"a-composable-template\"],\n \"migrated_component_templates\":[\"a-component-template\"]\n}" +} diff --git a/specification/ilm/move_to_step/MoveToStepRequestExample1.json b/specification/ilm/move_to_step/MoveToStepRequestExample1.json new file mode 100644 index 0000000000..62c1f2cf57 --- /dev/null +++ b/specification/ilm/move_to_step/MoveToStepRequestExample1.json @@ -0,0 +1,7 @@ +{ + "summary": "Triggers execution of a specific step in a lifecycle policy.", + "method_request": "POST _ilm/move/my-index-000001", + "description": "", + "type": "request", + "value": "{\n \"current_step\": {\n \"phase\": \"new\",\n \"action\": \"complete\",\n \"name\": \"complete\"\n },\n \"next_step\": {\n \"phase\": \"warm\",\n \"action\": \"forcemerge\",\n \"name\": \"forcemerge\"\n }\n}" +} diff --git a/specification/ilm/move_to_step/MoveToStepResponseExample1.json b/specification/ilm/move_to_step/MoveToStepResponseExample1.json new file mode 100644 index 0000000000..917e9b0d6b --- /dev/null +++ b/specification/ilm/move_to_step/MoveToStepResponseExample1.json @@ -0,0 +1,7 @@ +{ + "summary": "A successful response when triggering execution of a specific step in a lifecycle policy.", + "description": "", + "type": "response", + "response_code": 200, + "value": "{\n \"acknowledged\": true\n}" +} diff --git a/specification/ilm/put_lifecycle/PutLifecycleRequestExample1.json b/specification/ilm/put_lifecycle/PutLifecycleRequestExample1.json new file mode 100644 index 0000000000..02a9c357cc --- /dev/null +++ b/specification/ilm/put_lifecycle/PutLifecycleRequestExample1.json @@ -0,0 +1,7 @@ +{ + "summary": "Creates a lifecycle policy.", + "method_request": "PUT _ilm/policy/my_policy", + "description": "", + "type": "request", + "value": "{\n \"policy\": {\n \"_meta\": {\n \"description\": \"used for nginx log\",\n \"project\": {\n \"name\": \"myProject\",\n \"department\": \"myDepartment\"\n }\n },\n \"phases\": {\n \"warm\": {\n \"min_age\": \"10d\",\n \"actions\": {\n \"forcemerge\": {\n \"max_num_segments\": 1\n }\n }\n },\n \"delete\": {\n \"min_age\": \"30d\",\n \"actions\": {\n \"delete\": {}\n }\n }\n }\n }\n}" +} diff --git a/specification/ilm/put_lifecycle/PutLifecycleResponseExample1.json b/specification/ilm/put_lifecycle/PutLifecycleResponseExample1.json new file mode 100644 index 0000000000..2814c68c17 --- /dev/null +++ b/specification/ilm/put_lifecycle/PutLifecycleResponseExample1.json @@ -0,0 +1,7 @@ +{ + "summary": "A successful response when creating a new lifecycle policy.", + "description": "", + "type": "response", + "response_code": 200, + "value": "{\n \"acknowledged\": true\n}" +} diff --git a/specification/ilm/remove_policy/RemovePolicyResponseExample1.json b/specification/ilm/remove_policy/RemovePolicyResponseExample1.json new file mode 100644 index 0000000000..233c103bd9 --- /dev/null +++ b/specification/ilm/remove_policy/RemovePolicyResponseExample1.json @@ -0,0 +1,7 @@ +{ + "summary": "A successful response when removing a lifecycle policy from an index.", + "description": "", + "type": "response", + "response_code": 200, + "value": "{\n \"has_failures\" : false,\n \"failed_indexes\" : []\n}" +} diff --git a/specification/ilm/start/StartILMResponseExample1.json b/specification/ilm/start/StartILMResponseExample1.json new file mode 100644 index 0000000000..78c44e5db1 --- /dev/null +++ b/specification/ilm/start/StartILMResponseExample1.json @@ -0,0 +1,7 @@ +{ + "summary": "A successful response when stating the ILM plugin.", + "description": "", + "type": "response", + "response_code": 200, + "value": "{\n \"acknowledged\": true\n}" +} diff --git a/specification/ilm/stop/StopILMResponseExample1.json b/specification/ilm/stop/StopILMResponseExample1.json new file mode 100644 index 0000000000..eda703fcd7 --- /dev/null +++ b/specification/ilm/stop/StopILMResponseExample1.json @@ -0,0 +1,7 @@ +{ + "summary": "A successful response when stopping the ILM plugin.", + "description": "", + "type": "response", + "response_code": 200, + "value": "{\n \"acknowledged\": true\n}" +}