From 0faef9da439513fcb9508bfb0ea0f726b0d9261a Mon Sep 17 00:00:00 2001 From: Quentin Pradet Date: Thu, 27 Jun 2024 11:19:20 +0400 Subject: [PATCH 1/6] Switch to actions/setup-node@v4 (#2658) --- .github/workflows/code-format.yml | 6 +++--- .github/workflows/compiler.test.yml | 6 +++--- .github/workflows/generate.yml | 6 +++--- .github/workflows/gh-pages-report.yml | 6 +++--- .github/workflows/linter.yml | 6 +++--- .github/workflows/update-rest-api-json.yml | 6 +++--- .github/workflows/validate-pr.yml | 6 +++--- 7 files changed, 21 insertions(+), 21 deletions(-) diff --git a/.github/workflows/code-format.yml b/.github/workflows/code-format.yml index ebdc5e5903..62d098fa3a 100644 --- a/.github/workflows/code-format.yml +++ b/.github/workflows/code-format.yml @@ -10,10 +10,10 @@ jobs: steps: - uses: actions/checkout@v4 - - name: Use Node.js 20.x - uses: actions/setup-node@v1 + - name: Use Node.js 20 + uses: actions/setup-node@v4 with: - node-version: 20.x + node-version: 20 - name: Install run: | diff --git a/.github/workflows/compiler.test.yml b/.github/workflows/compiler.test.yml index 41ea11d65e..a19d5465c3 100644 --- a/.github/workflows/compiler.test.yml +++ b/.github/workflows/compiler.test.yml @@ -13,10 +13,10 @@ jobs: steps: - uses: actions/checkout@v4 - - name: Use Node.js 20.x - uses: actions/setup-node@v1 + - name: Use Node.js 20 + uses: actions/setup-node@v4 with: - node-version: 20.x + node-version: 20 - name: Install deps run: | diff --git a/.github/workflows/generate.yml b/.github/workflows/generate.yml index b6554a5f86..607aef22c1 100644 --- a/.github/workflows/generate.yml +++ b/.github/workflows/generate.yml @@ -34,10 +34,10 @@ jobs: token: ${{ secrets.PAT }} persist-credentials: true - - name: Setup Node 20.x - uses: actions/setup-node@v3 + - name: Setup Node 20 + uses: actions/setup-node@v4 with: - node-version: 20.x + node-version: 20 cache: npm cache-dependency-path: '**/package-lock.json' diff --git a/.github/workflows/gh-pages-report.yml b/.github/workflows/gh-pages-report.yml index defa95a023..fbf6d3d3e8 100644 --- a/.github/workflows/gh-pages-report.yml +++ b/.github/workflows/gh-pages-report.yml @@ -16,10 +16,10 @@ jobs: steps: - uses: actions/checkout@v4 - - name: Use Node.js 20.x - uses: actions/setup-node@v1 + - name: Use Node.js 20 + uses: actions/setup-node@v4 with: - node-version: 20.x + node-version: 20 - name: Install run: | diff --git a/.github/workflows/linter.yml b/.github/workflows/linter.yml index f796c2703f..cb59cb2989 100644 --- a/.github/workflows/linter.yml +++ b/.github/workflows/linter.yml @@ -10,10 +10,10 @@ jobs: steps: - uses: actions/checkout@v4 - - name: Use Node.js 20.x - uses: actions/setup-node@v1 + - name: Use Node.js 20 + uses: actions/setup-node@v4 with: - node-version: 20.x + node-version: 20 - name: Install run: | diff --git a/.github/workflows/update-rest-api-json.yml b/.github/workflows/update-rest-api-json.yml index f31334591a..4f51fec4a3 100644 --- a/.github/workflows/update-rest-api-json.yml +++ b/.github/workflows/update-rest-api-json.yml @@ -19,10 +19,10 @@ jobs: with: ref: ${{ matrix.branch }} - - name: Use Node.js 20.x - uses: actions/setup-node@v1 + - name: Use Node.js 20 + uses: actions/setup-node@v4 with: - node-version: 20.x + node-version: 20 - name: Install deps run: | diff --git a/.github/workflows/validate-pr.yml b/.github/workflows/validate-pr.yml index b76165ab4d..c5106a098d 100644 --- a/.github/workflows/validate-pr.yml +++ b/.github/workflows/validate-pr.yml @@ -26,10 +26,10 @@ jobs: token: ${{ secrets.PAT }} ref: main - - name: Use Node.js 20.x - uses: actions/setup-node@v1 + - name: Use Node.js 20 + uses: actions/setup-node@v4 with: - node-version: 20.x + node-version: 20 - name: Install deps 1/2 working-directory: ./clients-flight-recorder From ab67c8f2a43436de9f8ff8309cd039ecffeee28c Mon Sep 17 00:00:00 2001 From: Quentin Pradet Date: Thu, 27 Jun 2024 11:19:32 +0400 Subject: [PATCH 2/6] Switch to actions/labeler@v5 (#2647) This fixes a Node.js 16 deprecation warning. --- .github/labeler.yml | 13 ++++++++----- .github/workflows/labeler.yml | 2 +- 2 files changed, 9 insertions(+), 6 deletions(-) diff --git a/.github/labeler.yml b/.github/labeler.yml index 3f409691c2..e715b49bf5 100644 --- a/.github/labeler.yml +++ b/.github/labeler.yml @@ -1,12 +1,15 @@ documentation: - - '*.md' +- changed-files: + - any-glob-to-any-file: '*.md' specification: - - 'specification/**/*' +- changed-files: + - any-glob-to-any-file: 'specification/**/*' generator:typescript: - - 'typescript-generator/**/*' +- changed-files: + - any-glob-to-any-file: 'typescript-generator/**/*' compiler: - - 'compiler/**/*' - - 'compiler-rs/**/*' +- changed-files: + - any-glob-to-any-file: ['compiler/**/*', 'compiler-rs/**/*'] diff --git a/.github/workflows/labeler.yml b/.github/workflows/labeler.yml index 90d854452c..a788e56054 100644 --- a/.github/workflows/labeler.yml +++ b/.github/workflows/labeler.yml @@ -6,7 +6,7 @@ jobs: triage: runs-on: ubuntu-latest steps: - - uses: actions/labeler@v3 + - uses: actions/labeler@v5 with: repo-token: "${{ secrets.GITHUB_TOKEN }}" From 9638b2e53e4c43b96369b2114a62cf950f0578cb Mon Sep 17 00:00:00 2001 From: Quentin Pradet Date: Thu, 27 Jun 2024 11:20:09 +0400 Subject: [PATCH 3/6] Fix update rest-api-spec action (#2650) --- .github/workflows/update-rest-api-json.yml | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/.github/workflows/update-rest-api-json.yml b/.github/workflows/update-rest-api-json.yml index 4f51fec4a3..d5e4706a81 100644 --- a/.github/workflows/update-rest-api-json.yml +++ b/.github/workflows/update-rest-api-json.yml @@ -12,7 +12,7 @@ jobs: strategy: matrix: - branch: ['main', '8.8', '8.7', '7.17'] + branch: ['main', '8.13', '8.14', '7.17'] steps: - uses: actions/checkout@v4 @@ -43,19 +43,19 @@ jobs: git status --porcelain - name: Create Pull Request - uses: peter-evans/create-pull-request@v3 + uses: peter-evans/create-pull-request@v6 with: title: Update rest-api-spec ${{ matrix.branch }} body: 'As titled.' commit-message: 'Update rest-api-spec' labels: specification delete-branch: true - team-reviewers: elastic/clients-team + team-reviewers: elastic/devtools-team branch: automated/rest-api-spec-update-${{ matrix.branch }} - name: Open an issue if the action fails if: ${{ failure() }} - uses: nashmaniac/create-issue-action@v1.1 + uses: nashmaniac/create-issue-action@v1.2 with: title: rest-api-spec update failed token: ${{ secrets.GITHUB_TOKEN }} From 21b532fe17fbe3d4dbcd224a54dd8c5e3670d56c Mon Sep 17 00:00:00 2001 From: Quentin Pradet Date: Thu, 27 Jun 2024 11:29:55 +0400 Subject: [PATCH 4/6] Update rest-api-spec (#2657) --- output/schema/schema.json | 87 +++++++++++++++++++ output/schema/validation-errors.json | 54 +++++++----- .../_json_spec/connector.sync_job_claim.json | 32 +++++++ .../_json_spec/connector.update_features.json | 32 +++++++ .../_json_spec/features.reset_features.json | 6 ++ .../_json_spec/inference.delete.json | 2 +- .../_json_spec/ml.get_categories.json | 2 +- .../_json_spec/query_rule.delete.json | 6 +- specification/_json_spec/query_rule.get.json | 6 +- specification/_json_spec/query_rule.put.json | 8 +- specification/_json_spec/rollup.get_jobs.json | 2 +- .../_json_spec/rollup.get_rollup_caps.json | 2 +- .../_json_spec/security.get_settings.json | 7 +- .../_json_spec/security.put_privileges.json | 2 +- .../_json_spec/security.update_settings.json | 11 ++- specification/_json_spec/snapshot.delete.json | 5 ++ .../_json_spec/transform.get_node_stats.json | 21 +++++ 17 files changed, 244 insertions(+), 41 deletions(-) create mode 100644 specification/_json_spec/connector.sync_job_claim.json create mode 100644 specification/_json_spec/connector.update_features.json create mode 100644 specification/_json_spec/transform.get_node_stats.json diff --git a/output/schema/schema.json b/output/schema/schema.json index 1e5755ae2c..3f5aed5966 100644 --- a/output/schema/schema.json +++ b/output/schema/schema.json @@ -3562,6 +3562,36 @@ ], "visibility": "public" }, + { + "availability": { + "stack": { + "stability": "experimental", + "visibility": "public" + } + }, + "description": "Claims a connector sync job.", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/claim-connector-sync-job-api.html", + "name": "connector.sync_job_claim", + "request": null, + "requestBodyRequired": true, + "requestMediaType": [ + "application/json" + ], + "response": null, + "responseMediaType": [ + "application/json" + ], + "stability": "experimental", + "urls": [ + { + "methods": [ + "PUT" + ], + "path": "/_connector/_sync_job/{connector_sync_job_id}/_claim" + } + ], + "visibility": "public" + }, { "availability": { "serverless": { @@ -3949,6 +3979,36 @@ ], "visibility": "public" }, + { + "availability": { + "stack": { + "stability": "experimental", + "visibility": "public" + } + }, + "description": "Updates the connector features in the connector document.", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/update-connector-features-api.html", + "name": "connector.update_features", + "request": null, + "requestBodyRequired": true, + "requestMediaType": [ + "application/json" + ], + "response": null, + "responseMediaType": [ + "application/json" + ], + "stability": "experimental", + "urls": [ + { + "methods": [ + "PUT" + ], + "path": "/_connector/{connector_id}/_features" + } + ], + "visibility": "public" + }, { "availability": { "serverless": { @@ -20165,6 +20225,33 @@ ], "visibility": "public" }, + { + "availability": { + "stack": { + "stability": "stable", + "visibility": "public" + } + }, + "description": "Retrieves transform usage information for transform nodes.", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/get-transform-node-stats.html", + "name": "transform.get_node_stats", + "request": null, + "requestBodyRequired": false, + "response": null, + "responseMediaType": [ + "application/json" + ], + "stability": "stable", + "urls": [ + { + "methods": [ + "GET" + ], + "path": "/_transform/_node_stats" + } + ], + "visibility": "public" + }, { "availability": { "serverless": { diff --git a/output/schema/validation-errors.json b/output/schema/validation-errors.json index 54940e7fad..150eaf0092 100644 --- a/output/schema/validation-errors.json +++ b/output/schema/validation-errors.json @@ -577,6 +577,12 @@ ], "response": [] }, + "connector.sync_job_claim": { + "request": [ + "Missing request & response" + ], + "response": [] + }, "connector.sync_job_error": { "request": [ "Missing request & response" @@ -589,6 +595,12 @@ ], "response": [] }, + "connector.update_features": { + "request": [ + "Missing request & response" + ], + "response": [] + }, "enrich.delete_policy": { "request": [ "Request: missing json spec query parameter 'master_timeout'" @@ -653,6 +665,12 @@ ], "response": [] }, + "features.reset_features": { + "request": [ + "Request: missing json spec query parameter 'master_timeout'" + ], + "response": [] + }, "fleet.delete_secret": { "request": [ "Missing request & response" @@ -900,12 +918,6 @@ ], "response": [] }, - "ml.get_categories": { - "request": [ - "Url path '/_ml/anomaly_detectors/{job_id}/results/categories/' has a trailing slash" - ], - "response": [] - }, "ml.get_memory_stats": { "request": [ "Request: query parameter 'human' does not exist in the json spec", @@ -999,18 +1011,6 @@ ], "response": [] }, - "rollup.get_jobs": { - "request": [ - "Url path '/_rollup/job/' has a trailing slash" - ], - "response": [] - }, - "rollup.get_rollup_caps": { - "request": [ - "Url path '/_rollup/data/' has a trailing slash" - ], - "response": [] - }, "search": { "request": [ "Request: missing json spec query parameter 'include_named_queries_score'", @@ -1099,12 +1099,6 @@ ], "response": [] }, - "security.put_privileges": { - "request": [ - "Url path '/_security/privilege/' has a trailing slash" - ], - "response": [] - }, "security.query_user": { "request": [ "Missing request & response" @@ -1176,6 +1170,12 @@ ], "response": [] }, + "snapshot.delete": { + "request": [ + "Request: missing json spec query parameter 'wait_for_completion'" + ], + "response": [] + }, "snapshot.repository_analyze": { "request": [ "Missing request & response" @@ -1202,6 +1202,12 @@ ], "response": [] }, + "transform.get_node_stats": { + "request": [ + "Missing request & response" + ], + "response": [] + }, "transform.get_transform": { "request": [], "response": [ diff --git a/specification/_json_spec/connector.sync_job_claim.json b/specification/_json_spec/connector.sync_job_claim.json new file mode 100644 index 0000000000..29f7f8123c --- /dev/null +++ b/specification/_json_spec/connector.sync_job_claim.json @@ -0,0 +1,32 @@ +{ + "connector.sync_job_claim": { + "documentation": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/claim-connector-sync-job-api.html", + "description": "Claims a connector sync job." + }, + "stability": "experimental", + "visibility": "public", + "headers": { + "accept": ["application/json"], + "content_type": ["application/json"] + }, + "url": { + "paths": [ + { + "path": "/_connector/_sync_job/{connector_sync_job_id}/_claim", + "methods": ["PUT"], + "parts": { + "connector_sync_job_id": { + "type": "string", + "description": "The unique identifier of the connector sync job to be claimed." + } + } + } + ] + }, + "body": { + "description": "Data to claim a sync job.", + "required": true + } + } +} diff --git a/specification/_json_spec/connector.update_features.json b/specification/_json_spec/connector.update_features.json new file mode 100644 index 0000000000..5bd934ce02 --- /dev/null +++ b/specification/_json_spec/connector.update_features.json @@ -0,0 +1,32 @@ +{ + "connector.update_features": { + "documentation": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/update-connector-features-api.html", + "description": "Updates the connector features in the connector document." + }, + "stability": "experimental", + "visibility": "public", + "headers": { + "accept": ["application/json"], + "content_type": ["application/json"] + }, + "url": { + "paths": [ + { + "path": "/_connector/{connector_id}/_features", + "methods": ["PUT"], + "parts": { + "connector_id": { + "type": "string", + "description": "The unique identifier of the connector to be updated." + } + } + } + ] + }, + "body": { + "description": "An object containing the connector's features definition.", + "required": true + } + } +} diff --git a/specification/_json_spec/features.reset_features.json b/specification/_json_spec/features.reset_features.json index 447f73f213..7aad720b18 100644 --- a/specification/_json_spec/features.reset_features.json +++ b/specification/_json_spec/features.reset_features.json @@ -16,6 +16,12 @@ "methods": ["POST"] } ] + }, + "params": { + "master_timeout": { + "type": "time", + "description": "Explicit operation timeout for connection to master node" + } } } } diff --git a/specification/_json_spec/inference.delete.json b/specification/_json_spec/inference.delete.json index 39cf20ba7c..d9a0f0b0b6 100644 --- a/specification/_json_spec/inference.delete.json +++ b/specification/_json_spec/inference.delete.json @@ -45,7 +45,7 @@ }, "force": { "type": "boolean", - "description": "True if the endpoint should be forcefully stopped (regardless of whether or not it is referenced by any ingest processors or semantic text fields).", + "description": "If true the endpoint will be forcefully stopped (regardless of whether or not it is referenced by any ingest processors or semantic text fields).", "required": false } } diff --git a/specification/_json_spec/ml.get_categories.json b/specification/_json_spec/ml.get_categories.json index 5abc4d58f9..d90733e887 100644 --- a/specification/_json_spec/ml.get_categories.json +++ b/specification/_json_spec/ml.get_categories.json @@ -27,7 +27,7 @@ } }, { - "path": "/_ml/anomaly_detectors/{job_id}/results/categories/", + "path": "/_ml/anomaly_detectors/{job_id}/results/categories", "methods": ["GET", "POST"], "parts": { "job_id": { diff --git a/specification/_json_spec/query_rule.delete.json b/specification/_json_spec/query_rule.delete.json index 8624178f79..2db2bc83a2 100644 --- a/specification/_json_spec/query_rule.delete.json +++ b/specification/_json_spec/query_rule.delete.json @@ -2,7 +2,7 @@ "query_rule.delete": { "documentation": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/delete-query-rule.html", - "description": "Deletes an individual query rule within a query ruleset." + "description": "Deletes an individual query rule within a ruleset." }, "stability": "stable", "visibility": "public", @@ -17,11 +17,11 @@ "parts": { "ruleset_id": { "type": "string", - "description": "The unique identifier of the query ruleset containing the rule to delete" + "description": "The unique identifier of the query ruleset this rule exists in" }, "rule_id": { "type": "string", - "description": "The unique identifier of the query rule to delete" + "description": "The unique identifier of the rule to delete." } } } diff --git a/specification/_json_spec/query_rule.get.json b/specification/_json_spec/query_rule.get.json index dbd13f8b76..de2ff3e190 100644 --- a/specification/_json_spec/query_rule.get.json +++ b/specification/_json_spec/query_rule.get.json @@ -2,7 +2,7 @@ "query_rule.get": { "documentation": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/get-query-rule.html", - "description": "Returns the details about an individual query rule within a query ruleset." + "description": "Returns the details about an individual query rule within a ruleset." }, "stability": "stable", "visibility": "public", @@ -17,11 +17,11 @@ "parts": { "ruleset_id": { "type": "string", - "description": "The unique identifier of the query ruleset" + "description": "The unique identifier of the query ruleset the rule exists within" }, "rule_id": { "type": "string", - "description": "The unique identifier of the query rule" + "description": "The unique identifier of the rule to be retrieved." } } } diff --git a/specification/_json_spec/query_rule.put.json b/specification/_json_spec/query_rule.put.json index c98a219993..5856d0ae6a 100644 --- a/specification/_json_spec/query_rule.put.json +++ b/specification/_json_spec/query_rule.put.json @@ -2,7 +2,7 @@ "query_rule.put": { "documentation": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/put-query-rule.html", - "description": "Creates or updates an individual query rule within a query ruleset." + "description": "Creates or updates a query rule within a ruleset." }, "stability": "stable", "visibility": "public", @@ -18,18 +18,18 @@ "parts": { "ruleset_id": { "type": "string", - "description": "The unique identifier of the ruleset containing the rule to be created or updated." + "description": "The unique identifier of the ruleset this rule should be added to. The ruleset will be created if it does not exist." }, "rule_id": { "type": "string", - "description": "The unique identifier of the query rule to be created or updated." + "description": "The unique identifier of the rule to be created or updated." } } } ] }, "body": { - "description": "The query rule", + "description": "The query rule configuration, including the type of rule, the criteria to match the rule, and the action that should be taken if the rule matches.", "required": true } } diff --git a/specification/_json_spec/rollup.get_jobs.json b/specification/_json_spec/rollup.get_jobs.json index 849a2230a0..d15e12cae0 100644 --- a/specification/_json_spec/rollup.get_jobs.json +++ b/specification/_json_spec/rollup.get_jobs.json @@ -22,7 +22,7 @@ } }, { - "path": "/_rollup/job/", + "path": "/_rollup/job", "methods": ["GET"] } ] diff --git a/specification/_json_spec/rollup.get_rollup_caps.json b/specification/_json_spec/rollup.get_rollup_caps.json index 81cd0f6ad6..04ea752e65 100644 --- a/specification/_json_spec/rollup.get_rollup_caps.json +++ b/specification/_json_spec/rollup.get_rollup_caps.json @@ -22,7 +22,7 @@ } }, { - "path": "/_rollup/data/", + "path": "/_rollup/data", "methods": ["GET"] } ] diff --git a/specification/_json_spec/security.get_settings.json b/specification/_json_spec/security.get_settings.json index 2dc08e4e03..ff7d887738 100644 --- a/specification/_json_spec/security.get_settings.json +++ b/specification/_json_spec/security.get_settings.json @@ -18,6 +18,11 @@ } ] }, - "params": {} + "params": { + "master_timeout": { + "type": "time", + "description": "Timeout for connection to master" + } + } } } diff --git a/specification/_json_spec/security.put_privileges.json b/specification/_json_spec/security.put_privileges.json index 5041ad05f1..e13b556b87 100644 --- a/specification/_json_spec/security.put_privileges.json +++ b/specification/_json_spec/security.put_privileges.json @@ -13,7 +13,7 @@ "url": { "paths": [ { - "path": "/_security/privilege/", + "path": "/_security/privilege", "methods": ["PUT", "POST"] } ] diff --git a/specification/_json_spec/security.update_settings.json b/specification/_json_spec/security.update_settings.json index 7ddc65c7ae..fd3aa19945 100644 --- a/specification/_json_spec/security.update_settings.json +++ b/specification/_json_spec/security.update_settings.json @@ -18,7 +18,16 @@ } ] }, - "params": {}, + "params": { + "master_timeout": { + "type": "time", + "description": "Timeout for connection to master" + }, + "timeout": { + "type": "time", + "description": "Timeout for acknowledgements from all nodes" + } + }, "body": { "description": "An object with the new settings for each index, if any", "required": true diff --git a/specification/_json_spec/snapshot.delete.json b/specification/_json_spec/snapshot.delete.json index 5d9cfea44c..cf2bd26b93 100644 --- a/specification/_json_spec/snapshot.delete.json +++ b/specification/_json_spec/snapshot.delete.json @@ -31,6 +31,11 @@ "master_timeout": { "type": "time", "description": "Explicit operation timeout for connection to master node" + }, + "wait_for_completion": { + "type": "boolean", + "description": "Should this request wait until the operation has completed before returning", + "default": true } } } diff --git a/specification/_json_spec/transform.get_node_stats.json b/specification/_json_spec/transform.get_node_stats.json new file mode 100644 index 0000000000..335cbb557b --- /dev/null +++ b/specification/_json_spec/transform.get_node_stats.json @@ -0,0 +1,21 @@ +{ + "transform.get_node_stats": { + "documentation": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/get-transform-node-stats.html", + "description": "Retrieves transform usage information for transform nodes." + }, + "stability": "stable", + "visibility": "public", + "headers": { + "accept": ["application/json"] + }, + "url": { + "paths": [ + { + "path": "/_transform/_node_stats", + "methods": ["GET"] + } + ] + } + } +} From 745db535a3e7b9f0c973800ec46aeda933ae26a0 Mon Sep 17 00:00:00 2001 From: Lisa Cawley Date: Thu, 27 Jun 2024 07:39:53 -0700 Subject: [PATCH 5/6] Add operation summaries for index template APIs (#2634) --- Makefile | 5 ++- README.md | 6 +++ docs/doc-comments-guide.md | 7 +++ output/openapi/elasticsearch-openapi.json | 35 +++++++++------ .../elasticsearch-serverless-openapi.json | 26 ++++++----- output/schema/schema.json | 44 +++++++++---------- .../IndicesDeleteIndexTemplateRequest.ts | 1 + .../IndicesExistsTemplateRequest.ts | 2 + .../IndicesGetIndexTemplateRequest.ts | 1 + .../get_template/IndicesGetTemplateRequest.ts | 1 + .../IndicesPutIndexTemplateRequest.ts | 2 +- .../put_template/IndicesPutTemplateRequest.ts | 2 +- .../IndicesSimulateIndexTemplateRequest.ts | 3 +- .../IndicesSimulateTemplateRequest.ts | 1 + 14 files changed, 87 insertions(+), 49 deletions(-) diff --git a/Makefile b/Makefile index 03b736e89f..e57814cf3d 100644 --- a/Makefile +++ b/Makefile @@ -60,7 +60,10 @@ dump-routes: ## Create a new schema with all generics expanded contrib: | generate license-check spec-format-fix transform-to-openapi ## Pre contribution target lint-docs: ## Lint the OpenAPI documents - @npx @stoplight/spectral-cli lint output/openapi/elasticsearch-serverless-openapi.json + @npx @stoplight/spectral-cli lint output/openapi/*.json --ruleset .spectral.yaml + +lint-docs-serverless: ## Lint only the serverless OpenAPI document + @npx @stoplight/spectral-cli lint output/openapi/elasticsearch-serverless-openapi.json --ruleset .spectral.yaml help: ## Display help @awk 'BEGIN {FS = ":.*##"; printf "Usage:\n make \033[36m\033[0m\n"} /^[a-zA-Z_-]+:.*?##/ { printf " \033[36m%-15s\033[0m %s\n", $$1, $$2 } /^##@/ { printf "\n\033[1m%s\033[0m\n", substr($$0, 5) } ' $(MAKEFILE_LIST) diff --git a/README.md b/README.md index 468e411b71..fb5de610be 100644 --- a/README.md +++ b/README.md @@ -69,7 +69,13 @@ Usage: spec-dangling-types Generate the dangling types rreport setup Install dependencies for contrib target clean-dep Clean npm dependencies + transform-expand-generics Create a new schema with all generics expanded + transform-to-openapi Generate the OpenAPI definition from the compiled schema + filter-for-serverless Generate the serverless version from the compiled schema + dump-routes Create a new schema with all generics expanded contrib Pre contribution target + lint-docs Lint the OpenAPI documents + lint-docs-serverless Lint only the serverless OpenAPI document help Display help ``` diff --git a/docs/doc-comments-guide.md b/docs/doc-comments-guide.md index e89994516b..c8174e8ef9 100644 --- a/docs/doc-comments-guide.md +++ b/docs/doc-comments-guide.md @@ -4,12 +4,19 @@ A specification is not only about formalizing data structures, it's also about e Documentation of the TypeScript specification is made using [JSDoc](https://jsdoc.app/) comments, i.e. multiline comments starting with `/**` above a type or field declaration. +The first phrase is used as the mandatory operation summary in the OpenAPI document. +Refer to [API documentation guidelines](https://docs.elastic.dev/content-architecture/oas#summaries). + +NOTE: You must add a period or `\n` at the end of the phrase for it to parse correctly. +The period will be properly omitted from the output OpenAPI document. + Additional lines start with a `*` followed by a space. Long lines are allowed but it's better if text is formatted to a maximum of 120 characters per line. ## Example ```ts /** + * Get ranking evaluation. * Enables you to evaluate the quality of ranked search results over a set of typical search queries. * @rest_spec_name rank_eval * @availability stack since=6.2.0 stability=stable diff --git a/output/openapi/elasticsearch-openapi.json b/output/openapi/elasticsearch-openapi.json index b20f143ed8..6c44bc4f7c 100644 --- a/output/openapi/elasticsearch-openapi.json +++ b/output/openapi/elasticsearch-openapi.json @@ -11783,7 +11783,8 @@ "tags": [ "indices.get_index_template" ], - "summary": "Returns information about one or more index templates", + "summary": "Get index templates", + "description": "Returns information about one or more index templates.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-get-template.html" }, @@ -11815,7 +11816,7 @@ "tags": [ "indices.put_index_template" ], - "summary": "Creates or updates an index template", + "summary": "Create or update an index template", "description": "Index templates define settings, mappings, and aliases that can be applied automatically to new indices.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-put-template.html" @@ -11848,7 +11849,7 @@ "tags": [ "indices.put_index_template" ], - "summary": "Creates or updates an index template", + "summary": "Create or update an index template", "description": "Index templates define settings, mappings, and aliases that can be applied automatically to new indices.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-put-template.html" @@ -11881,8 +11882,8 @@ "tags": [ "indices.delete_index_template" ], - "summary": "The provided may contain multiple template names separated by a comma", - "description": "If multiple template names are specified then there is no wildcard support and the provided names should match completely with existing templates.", + "summary": "Delete an index template", + "description": "The provided may contain multiple template names separated by a comma. If multiple template names are specified then there is no wildcard support and the provided names should match completely with existing templates.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-delete-template.html" }, @@ -11980,7 +11981,8 @@ "tags": [ "indices.get_template" ], - "summary": "Retrieves information about one or more index templates", + "summary": "Get index templates", + "description": "Retrieves information about one or more index templates.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-get-template-v1.html" }, @@ -12009,7 +12011,7 @@ "tags": [ "indices.put_template" ], - "summary": "Creates or updates an index template", + "summary": "Create or update an index template", "description": "Index templates define settings, mappings, and aliases that can be applied automatically to new indices.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-templates-v1.html" @@ -12045,7 +12047,7 @@ "tags": [ "indices.put_template" ], - "summary": "Creates or updates an index template", + "summary": "Create or update an index template", "description": "Index templates define settings, mappings, and aliases that can be applied automatically to new indices.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-templates-v1.html" @@ -12136,7 +12138,8 @@ "tags": [ "indices.exists_template" ], - "summary": "Returns information about whether a particular index template exists", + "summary": "Check existence of index templates", + "description": "Returns information about whether a particular index template exists.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-template-exists-v1.html" }, @@ -12975,7 +12978,8 @@ "tags": [ "indices.get_index_template" ], - "summary": "Returns information about one or more index templates", + "summary": "Get index templates", + "description": "Returns information about one or more index templates.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-get-template.html" }, @@ -13426,7 +13430,8 @@ "tags": [ "indices.get_template" ], - "summary": "Retrieves information about one or more index templates", + "summary": "Get index templates", + "description": "Retrieves information about one or more index templates.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-get-template-v1.html" }, @@ -14355,6 +14360,8 @@ "tags": [ "indices.simulate_index_template" ], + "summary": "Simulate an index", + "description": "Returns the index configuration that would be applied to the specified index from an existing index template.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-simulate-index.html" }, @@ -14425,7 +14432,8 @@ "tags": [ "indices.simulate_template" ], - "summary": "Returns the index configuration that would be applied by a particular index template", + "summary": "Simulate an index template", + "description": "Returns the index configuration that would be applied by a particular index template.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-simulate-template.html" }, @@ -14456,7 +14464,8 @@ "tags": [ "indices.simulate_template" ], - "summary": "Returns the index configuration that would be applied by a particular index template", + "summary": "Simulate an index template", + "description": "Returns the index configuration that would be applied by a particular index template.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-simulate-template.html" }, diff --git a/output/openapi/elasticsearch-serverless-openapi.json b/output/openapi/elasticsearch-serverless-openapi.json index 0f4806583b..f495a8f9db 100644 --- a/output/openapi/elasticsearch-serverless-openapi.json +++ b/output/openapi/elasticsearch-serverless-openapi.json @@ -7350,7 +7350,8 @@ "tags": [ "indices.get_index_template" ], - "summary": "Returns information about one or more index templates", + "summary": "Get index templates", + "description": "Returns information about one or more index templates.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-get-template.html" }, @@ -7382,7 +7383,7 @@ "tags": [ "indices.put_index_template" ], - "summary": "Creates or updates an index template", + "summary": "Create or update an index template", "description": "Index templates define settings, mappings, and aliases that can be applied automatically to new indices.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-put-template.html" @@ -7415,7 +7416,7 @@ "tags": [ "indices.put_index_template" ], - "summary": "Creates or updates an index template", + "summary": "Create or update an index template", "description": "Index templates define settings, mappings, and aliases that can be applied automatically to new indices.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-put-template.html" @@ -7448,8 +7449,8 @@ "tags": [ "indices.delete_index_template" ], - "summary": "The provided may contain multiple template names separated by a comma", - "description": "If multiple template names are specified then there is no wildcard support and the provided names should match completely with existing templates.", + "summary": "Delete an index template", + "description": "The provided may contain multiple template names separated by a comma. If multiple template names are specified then there is no wildcard support and the provided names should match completely with existing templates.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-delete-template.html" }, @@ -7771,7 +7772,8 @@ "tags": [ "indices.get_index_template" ], - "summary": "Returns information about one or more index templates", + "summary": "Get index templates", + "description": "Returns information about one or more index templates.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-get-template.html" }, @@ -8306,7 +8308,7 @@ "tags": [ "indices.put_template" ], - "summary": "Creates or updates an index template", + "summary": "Create or update an index template", "description": "Index templates define settings, mappings, and aliases that can be applied automatically to new indices.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-templates-v1.html" @@ -8342,7 +8344,7 @@ "tags": [ "indices.put_template" ], - "summary": "Creates or updates an index template", + "summary": "Create or update an index template", "description": "Index templates define settings, mappings, and aliases that can be applied automatically to new indices.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-templates-v1.html" @@ -8648,6 +8650,8 @@ "tags": [ "indices.simulate_index_template" ], + "summary": "Simulate an index", + "description": "Returns the index configuration that would be applied to the specified index from an existing index template.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-simulate-index.html" }, @@ -8718,7 +8722,8 @@ "tags": [ "indices.simulate_template" ], - "summary": "Returns the index configuration that would be applied by a particular index template", + "summary": "Simulate an index template", + "description": "Returns the index configuration that would be applied by a particular index template.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-simulate-template.html" }, @@ -8749,7 +8754,8 @@ "tags": [ "indices.simulate_template" ], - "summary": "Returns the index configuration that would be applied by a particular index template", + "summary": "Simulate an index template", + "description": "Returns the index configuration that would be applied by a particular index template.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-simulate-template.html" }, diff --git a/output/schema/schema.json b/output/schema/schema.json index 3f5aed5966..5415ca4a44 100644 --- a/output/schema/schema.json +++ b/output/schema/schema.json @@ -6916,7 +6916,7 @@ "stability": "stable" } }, - "description": "The provided may contain multiple template names separated by a comma. If multiple template\nnames are specified then there is no wildcard support and the provided names should match completely with\nexisting templates.", + "description": "Delete an index template.\nThe provided may contain multiple template names separated by a comma. If multiple template\nnames are specified then there is no wildcard support and the provided names should match completely with\nexisting templates.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-delete-template.html", "name": "indices.delete_index_template", "privileges": { @@ -7197,7 +7197,7 @@ "stability": "stable" } }, - "description": "Returns information about whether a particular index template exists.", + "description": "Check existence of index templates.\nReturns information about whether a particular index template exists.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-template-exists-v1.html", "name": "indices.exists_template", "request": { @@ -7634,7 +7634,7 @@ "stability": "stable" } }, - "description": "Returns information about one or more index templates.", + "description": "Get index templates.\nReturns information about one or more index templates.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-get-template.html", "name": "indices.get_index_template", "privileges": { @@ -7787,7 +7787,7 @@ "stability": "stable" } }, - "description": "Retrieves information about one or more index templates.", + "description": "Get index templates.\nRetrieves information about one or more index templates.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-get-template-v1.html", "name": "indices.get_template", "request": { @@ -8074,7 +8074,7 @@ "stability": "stable" } }, - "description": "Creates or updates an index template.\nIndex templates define settings, mappings, and aliases that can be applied automatically to new indices.", + "description": "Create or update an index template.\nIndex templates define settings, mappings, and aliases that can be applied automatically to new indices.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-put-template.html", "name": "indices.put_index_template", "request": { @@ -8210,7 +8210,7 @@ "stability": "stable" } }, - "description": "Creates or updates an index template.\nIndex templates define settings, mappings, and aliases that can be applied automatically to new indices.", + "description": "Create or update an index template.\nIndex templates define settings, mappings, and aliases that can be applied automatically to new indices.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-templates-v1.html", "name": "indices.put_template", "request": { @@ -8620,7 +8620,7 @@ "stability": "stable" } }, - "description": "", + "description": "Simulate an index.\nReturns the index configuration that would be applied to the specified index from an existing index template.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-simulate-index.html", "name": "indices.simulate_index_template", "request": { @@ -8661,7 +8661,7 @@ "stability": "stable" } }, - "description": "Returns the index configuration that would be applied by a particular index template.", + "description": "Simulate an index template.\nReturns the index configuration that would be applied by a particular index template.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-simulate-template.html", "name": "indices.simulate_template", "privileges": { @@ -124764,7 +124764,7 @@ "body": { "kind": "no_body" }, - "description": "The provided may contain multiple template names separated by a comma. If multiple template\nnames are specified then there is no wildcard support and the provided names should match completely with\nexisting templates.", + "description": "Delete an index template.\nThe provided may contain multiple template names separated by a comma. If multiple template\nnames are specified then there is no wildcard support and the provided names should match completely with\nexisting templates.", "inherits": { "type": { "name": "RequestBase", @@ -124818,7 +124818,7 @@ } } ], - "specLocation": "indices/delete_index_template/IndicesDeleteIndexTemplateRequest.ts#L24-L52" + "specLocation": "indices/delete_index_template/IndicesDeleteIndexTemplateRequest.ts#L24-L53" }, { "body": { @@ -125411,7 +125411,7 @@ "body": { "kind": "no_body" }, - "description": "Returns information about whether a particular index template exists.", + "description": "Check existence of index templates.\nReturns information about whether a particular index template exists.", "inherits": { "type": { "name": "RequestBase", @@ -125475,7 +125475,7 @@ } } ], - "specLocation": "indices/exists_template/IndicesExistsTemplateRequest.ts#L24-L37" + "specLocation": "indices/exists_template/IndicesExistsTemplateRequest.ts#L24-L39" }, { "body": { @@ -127358,7 +127358,7 @@ "body": { "kind": "no_body" }, - "description": "Returns information about one or more index templates.", + "description": "Get index templates.\nReturns information about one or more index templates.", "inherits": { "type": { "name": "RequestBase", @@ -127449,7 +127449,7 @@ } } ], - "specLocation": "indices/get_index_template/IndicesGetIndexTemplateRequest.ts#L24-L60" + "specLocation": "indices/get_index_template/IndicesGetIndexTemplateRequest.ts#L24-L61" }, { "body": { @@ -127817,7 +127817,7 @@ "body": { "kind": "no_body" }, - "description": "Retrieves information about one or more index templates.", + "description": "Get index templates.\nRetrieves information about one or more index templates.", "inherits": { "type": { "name": "RequestBase", @@ -127884,7 +127884,7 @@ } } ], - "specLocation": "indices/get_template/IndicesGetTemplateRequest.ts#L24-L56" + "specLocation": "indices/get_template/IndicesGetTemplateRequest.ts#L24-L57" }, { "body": { @@ -128793,7 +128793,7 @@ } ] }, - "description": "Creates or updates an index template.\nIndex templates define settings, mappings, and aliases that can be applied automatically to new indices.", + "description": "Create or update an index template.\nIndex templates define settings, mappings, and aliases that can be applied automatically to new indices.", "inherits": { "type": { "name": "RequestBase", @@ -129459,7 +129459,7 @@ } ] }, - "description": "Creates or updates an index template.\nIndex templates define settings, mappings, and aliases that can be applied automatically to new indices.", + "description": "Create or update an index template.\nIndex templates define settings, mappings, and aliases that can be applied automatically to new indices.", "inherits": { "type": { "name": "RequestBase", @@ -132786,7 +132786,7 @@ "body": { "kind": "no_body" }, - "description": "", + "description": "Simulate an index.\nReturns the index configuration that would be applied to the specified index from an existing index template.", "inherits": { "type": { "name": "RequestBase", @@ -132851,7 +132851,7 @@ } } ], - "specLocation": "indices/simulate_index_template/IndicesSimulateIndexTemplateRequest.ts#L24-L49" + "specLocation": "indices/simulate_index_template/IndicesSimulateIndexTemplateRequest.ts#L24-L50" }, { "body": { @@ -133065,7 +133065,7 @@ } ] }, - "description": "Returns the index configuration that would be applied by a particular index template.", + "description": "Simulate an index template.\nReturns the index configuration that would be applied by a particular index template.", "inherits": { "type": { "name": "RequestBase", @@ -133143,7 +133143,7 @@ } } ], - "specLocation": "indices/simulate_template/IndicesSimulateTemplateRequest.ts#L27-L119" + "specLocation": "indices/simulate_template/IndicesSimulateTemplateRequest.ts#L27-L120" }, { "body": { diff --git a/specification/indices/delete_index_template/IndicesDeleteIndexTemplateRequest.ts b/specification/indices/delete_index_template/IndicesDeleteIndexTemplateRequest.ts index 75d74577c2..d2ef9dda1f 100644 --- a/specification/indices/delete_index_template/IndicesDeleteIndexTemplateRequest.ts +++ b/specification/indices/delete_index_template/IndicesDeleteIndexTemplateRequest.ts @@ -22,6 +22,7 @@ import { Names } from '@_types/common' import { Duration } from '@_types/Time' /** + * Delete an index template. * The provided may contain multiple template names separated by a comma. If multiple template * names are specified then there is no wildcard support and the provided names should match completely with * existing templates. diff --git a/specification/indices/exists_template/IndicesExistsTemplateRequest.ts b/specification/indices/exists_template/IndicesExistsTemplateRequest.ts index 257ebedbe9..51be3c9df9 100644 --- a/specification/indices/exists_template/IndicesExistsTemplateRequest.ts +++ b/specification/indices/exists_template/IndicesExistsTemplateRequest.ts @@ -22,6 +22,8 @@ import { Names } from '@_types/common' import { Duration } from '@_types/Time' /** + * Check existence of index templates. + * Returns information about whether a particular index template exists. * @rest_spec_name indices.exists_template * @availability stack since=0.0.0 stability=stable */ diff --git a/specification/indices/get_index_template/IndicesGetIndexTemplateRequest.ts b/specification/indices/get_index_template/IndicesGetIndexTemplateRequest.ts index cd44f4161a..f24412100d 100644 --- a/specification/indices/get_index_template/IndicesGetIndexTemplateRequest.ts +++ b/specification/indices/get_index_template/IndicesGetIndexTemplateRequest.ts @@ -22,6 +22,7 @@ import { Name } from '@_types/common' import { Duration } from '@_types/Time' /** + * Get index templates. * Returns information about one or more index templates. * @rest_spec_name indices.get_index_template * @availability stack since=7.9.0 stability=stable diff --git a/specification/indices/get_template/IndicesGetTemplateRequest.ts b/specification/indices/get_template/IndicesGetTemplateRequest.ts index 88547d8d2b..89e159dcd2 100644 --- a/specification/indices/get_template/IndicesGetTemplateRequest.ts +++ b/specification/indices/get_template/IndicesGetTemplateRequest.ts @@ -22,6 +22,7 @@ import { Names } from '@_types/common' import { Duration } from '@_types/Time' /** + * Get index templates. * Retrieves information about one or more index templates. * @rest_spec_name indices.get_template * @availability stack since=0.0.0 stability=stable diff --git a/specification/indices/put_index_template/IndicesPutIndexTemplateRequest.ts b/specification/indices/put_index_template/IndicesPutIndexTemplateRequest.ts index 4b01a7dc22..70462aa7c5 100644 --- a/specification/indices/put_index_template/IndicesPutIndexTemplateRequest.ts +++ b/specification/indices/put_index_template/IndicesPutIndexTemplateRequest.ts @@ -35,7 +35,7 @@ import { DataStreamLifecycle } from '@indices/_types/DataStreamLifecycle' import { Duration } from '@_types/Time' /** - * Creates or updates an index template. + * Create or update an index template. * Index templates define settings, mappings, and aliases that can be applied automatically to new indices. * @rest_spec_name indices.put_index_template * @availability stack since=7.9.0 stability=stable diff --git a/specification/indices/put_template/IndicesPutTemplateRequest.ts b/specification/indices/put_template/IndicesPutTemplateRequest.ts index 6407101f81..087c9bd16c 100644 --- a/specification/indices/put_template/IndicesPutTemplateRequest.ts +++ b/specification/indices/put_template/IndicesPutTemplateRequest.ts @@ -27,7 +27,7 @@ import { Duration } from '@_types/Time' import { IndexSettings } from '@indices/_types/IndexSettings' /** - * Creates or updates an index template. + * Create or update an index template. * Index templates define settings, mappings, and aliases that can be applied automatically to new indices. * @rest_spec_name indices.put_template * @availability stack since=0.0.0 stability=stable diff --git a/specification/indices/simulate_index_template/IndicesSimulateIndexTemplateRequest.ts b/specification/indices/simulate_index_template/IndicesSimulateIndexTemplateRequest.ts index b4d1d32b00..0cad3bcfc0 100644 --- a/specification/indices/simulate_index_template/IndicesSimulateIndexTemplateRequest.ts +++ b/specification/indices/simulate_index_template/IndicesSimulateIndexTemplateRequest.ts @@ -22,7 +22,8 @@ import { Name } from '@_types/common' import { Duration } from '@_types/Time' /** - * + * Simulate an index. + * Returns the index configuration that would be applied to the specified index from an existing index template. * @rest_spec_name indices.simulate_index_template * @availability stack since=7.9.0 stability=stable * @availability serverless stability=stable visibility=public diff --git a/specification/indices/simulate_template/IndicesSimulateTemplateRequest.ts b/specification/indices/simulate_template/IndicesSimulateTemplateRequest.ts index 71381f26c4..7b60dd7b82 100644 --- a/specification/indices/simulate_template/IndicesSimulateTemplateRequest.ts +++ b/specification/indices/simulate_template/IndicesSimulateTemplateRequest.ts @@ -25,6 +25,7 @@ import { DataStreamVisibility } from '@indices/_types/DataStream' import { long } from '@_types/Numeric' /** + * Simulate an index template. * Returns the index configuration that would be applied by a particular index template. * @rest_spec_name indices.simulate_template * @availability stack since=0.0.0 stability=stable From d6c38fed3d05e3fc04ad632837a8b831e6534605 Mon Sep 17 00:00:00 2001 From: Elastic Machine Date: Thu, 27 Jun 2024 14:40:36 +0000 Subject: [PATCH 6/6] Update specification output --- output/schema/schema-serverless.json | 32 ++++++++++++++-------------- 1 file changed, 16 insertions(+), 16 deletions(-) diff --git a/output/schema/schema-serverless.json b/output/schema/schema-serverless.json index a77b078b7d..d3ea29460d 100644 --- a/output/schema/schema-serverless.json +++ b/output/schema/schema-serverless.json @@ -3459,7 +3459,7 @@ "stability": "stable" } }, - "description": "The provided may contain multiple template names separated by a comma. If multiple template\nnames are specified then there is no wildcard support and the provided names should match completely with\nexisting templates.", + "description": "Delete an index template.\nThe provided may contain multiple template names separated by a comma. If multiple template\nnames are specified then there is no wildcard support and the provided names should match completely with\nexisting templates.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-delete-template.html", "name": "indices.delete_index_template", "privileges": { @@ -3848,7 +3848,7 @@ "stability": "stable" } }, - "description": "Returns information about one or more index templates.", + "description": "Get index templates.\nReturns information about one or more index templates.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-get-template.html", "name": "indices.get_index_template", "privileges": { @@ -4176,7 +4176,7 @@ "stability": "stable" } }, - "description": "Creates or updates an index template.\nIndex templates define settings, mappings, and aliases that can be applied automatically to new indices.", + "description": "Create or update an index template.\nIndex templates define settings, mappings, and aliases that can be applied automatically to new indices.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-put-template.html", "name": "indices.put_index_template", "request": { @@ -4312,7 +4312,7 @@ "stability": "stable" } }, - "description": "Creates or updates an index template.\nIndex templates define settings, mappings, and aliases that can be applied automatically to new indices.", + "description": "Create or update an index template.\nIndex templates define settings, mappings, and aliases that can be applied automatically to new indices.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-templates-v1.html", "name": "indices.put_template", "request": { @@ -4486,7 +4486,7 @@ "stability": "stable" } }, - "description": "", + "description": "Simulate an index.\nReturns the index configuration that would be applied to the specified index from an existing index template.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-simulate-index.html", "name": "indices.simulate_index_template", "request": { @@ -4527,7 +4527,7 @@ "stability": "stable" } }, - "description": "Returns the index configuration that would be applied by a particular index template.", + "description": "Simulate an index template.\nReturns the index configuration that would be applied by a particular index template.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-simulate-template.html", "name": "indices.simulate_template", "privileges": { @@ -21620,7 +21620,7 @@ "body": { "kind": "no_body" }, - "description": "The provided may contain multiple template names separated by a comma. If multiple template\nnames are specified then there is no wildcard support and the provided names should match completely with\nexisting templates.", + "description": "Delete an index template.\nThe provided may contain multiple template names separated by a comma. If multiple template\nnames are specified then there is no wildcard support and the provided names should match completely with\nexisting templates.", "inherits": { "type": { "name": "RequestBase", @@ -21674,7 +21674,7 @@ } } ], - "specLocation": "indices/delete_index_template/IndicesDeleteIndexTemplateRequest.ts#L24-L52" + "specLocation": "indices/delete_index_template/IndicesDeleteIndexTemplateRequest.ts#L24-L53" }, { "body": { @@ -22623,7 +22623,7 @@ "body": { "kind": "no_body" }, - "description": "Returns information about one or more index templates.", + "description": "Get index templates.\nReturns information about one or more index templates.", "inherits": { "type": { "name": "RequestBase", @@ -22714,7 +22714,7 @@ } } ], - "specLocation": "indices/get_index_template/IndicesGetIndexTemplateRequest.ts#L24-L60" + "specLocation": "indices/get_index_template/IndicesGetIndexTemplateRequest.ts#L24-L61" }, { "body": { @@ -23569,7 +23569,7 @@ } ] }, - "description": "Creates or updates an index template.\nIndex templates define settings, mappings, and aliases that can be applied automatically to new indices.", + "description": "Create or update an index template.\nIndex templates define settings, mappings, and aliases that can be applied automatically to new indices.", "inherits": { "type": { "name": "RequestBase", @@ -24235,7 +24235,7 @@ } ] }, - "description": "Creates or updates an index template.\nIndex templates define settings, mappings, and aliases that can be applied automatically to new indices.", + "description": "Create or update an index template.\nIndex templates define settings, mappings, and aliases that can be applied automatically to new indices.", "inherits": { "type": { "name": "RequestBase", @@ -24808,7 +24808,7 @@ "body": { "kind": "no_body" }, - "description": "", + "description": "Simulate an index.\nReturns the index configuration that would be applied to the specified index from an existing index template.", "inherits": { "type": { "name": "RequestBase", @@ -24873,7 +24873,7 @@ } } ], - "specLocation": "indices/simulate_index_template/IndicesSimulateIndexTemplateRequest.ts#L24-L49" + "specLocation": "indices/simulate_index_template/IndicesSimulateIndexTemplateRequest.ts#L24-L50" }, { "body": { @@ -25052,7 +25052,7 @@ } ] }, - "description": "Returns the index configuration that would be applied by a particular index template.", + "description": "Simulate an index template.\nReturns the index configuration that would be applied by a particular index template.", "inherits": { "type": { "name": "RequestBase", @@ -25130,7 +25130,7 @@ } } ], - "specLocation": "indices/simulate_template/IndicesSimulateTemplateRequest.ts#L27-L119" + "specLocation": "indices/simulate_template/IndicesSimulateTemplateRequest.ts#L27-L120" }, { "body": {