Skip to content

rest-api-spec: use list type in parts when appropriate #5690

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
pquentin merged 1 commit into from
Nov 18, 2025
Merged

rest-api-spec: use list type in parts when appropriate #5690

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions output/openapi/elasticsearch-openapi.json
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

4 changes: 2 additions & 2 deletions output/openapi/elasticsearch-serverless-openapi.json
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

6 changes: 3 additions & 3 deletions output/schema/schema.json
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion specification/_json_spec/bulk.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@
"description": "If `true` then refresh the affected shards to make this operation visible to search, if `wait_for` then wait for a refresh to make this operation visible to search, if `false` (the default) then do nothing with refreshes."
},
"routing": {
"type": "string",
"type": "list",
"description": "Specific routing value"
},
"timeout": {
Expand Down
4 changes: 2 additions & 2 deletions specification/_json_spec/cluster.delete_component_template.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,8 +16,8 @@
"methods": ["DELETE"],
"parts": {
"name": {
"type": "string",
"description": "The name of the template"
"type": "list",
"description": "Comma-separated list or wildcard expression of component template names used to limit the request."
}
}
}
Expand Down
4 changes: 2 additions & 2 deletions specification/_json_spec/cluster.exists_component_template.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,8 +16,8 @@
"methods": ["HEAD"],
"parts": {
"name": {
"type": "string",
"description": "The name of the template"
"type": "list",
"description": "Comma-separated list of component template names used to limit the request. Wildcard (*) expressions are supported."
}
}
}
Expand Down
2 changes: 1 addition & 1 deletion specification/_json_spec/create.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@
"description": "If `true` then refresh the affected shards to make this operation visible to search, if `wait_for` then wait for a refresh to make this operation visible to search, if `false` (the default) then do nothing with refreshes."
},
"routing": {
"type": "string",
"type": "list",
"description": "Specific routing value"
},
"timeout": {
Expand Down
2 changes: 1 addition & 1 deletion specification/_json_spec/delete.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@
"description": "If `true` then refresh the affected shards to make this operation visible to search, if `wait_for` then wait for a refresh to make this operation visible to search, if `false` (the default) then do nothing with refreshes."
},
"routing": {
"type": "string",
"type": "list",
"description": "Specific routing value"
},
"timeout": {
Expand Down
4 changes: 2 additions & 2 deletions specification/_json_spec/eql.search.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,8 +17,8 @@
"methods": ["GET", "POST"],
"parts": {
"index": {
"type": "string",
"description": "The name of the index to scope the operation"
"type": "list",
"description": "Comma-separated list of index names to scope the operation"
}
}
}
Expand Down
2 changes: 1 addition & 1 deletion specification/_json_spec/exists.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@
"description": "Refresh the shard containing the document before performing the operation"
},
"routing": {
"type": "string",
"type": "list",
"description": "Specific routing value"
},
"_source": {
Expand Down
2 changes: 1 addition & 1 deletion specification/_json_spec/exists_source.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@
"description": "Refresh the shard containing the document before performing the operation"
},
"routing": {
"type": "string",
"type": "list",
"description": "Specific routing value"
},
"_source": {
Expand Down
2 changes: 1 addition & 1 deletion specification/_json_spec/explain.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -66,7 +66,7 @@
"description": "Query in the Lucene query string syntax"
},
"routing": {
"type": "string",
"type": "list",
"description": "Specific routing value"
},
"_source": {
Expand Down
2 changes: 1 addition & 1 deletion specification/_json_spec/get.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,7 @@
"description": "Refresh the shard containing the document before performing the operation"
},
"routing": {
"type": "string",
"type": "list",
"description": "Specific routing value"
},
"_source": {
Expand Down
2 changes: 1 addition & 1 deletion specification/_json_spec/get_source.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@
"description": "Refresh the shard containing the document before performing the operation"
},
"routing": {
"type": "string",
"type": "list",
"description": "Specific routing value"
},
"_source": {
Expand Down
2 changes: 1 addition & 1 deletion specification/_json_spec/graph.explore.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@
},
"params": {
"routing": {
"type": "string",
"type": "list",
"description": "Specific routing value"
},
"timeout": {
Expand Down
4 changes: 2 additions & 2 deletions specification/_json_spec/health_report.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,8 +20,8 @@
"methods": ["GET"],
"parts": {
"feature": {
"type": "string",
"description": "A feature of the cluster, as returned by the top-level health API"
"type": "list",
"description": "Comma-separated list of cluster features, as returned by the top-level health report API."
}
}
}
Expand Down
2 changes: 1 addition & 1 deletion specification/_json_spec/index.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,7 @@
"description": "If `true` then refresh the affected shards to make this operation visible to search, if `wait_for` then wait for a refresh to make this operation visible to search, if `false` (the default) then do nothing with refreshes."
},
"routing": {
"type": "string",
"type": "list",
"description": "Specific routing value"
},
"timeout": {
Expand Down
4 changes: 2 additions & 2 deletions specification/_json_spec/indices.cancel_migrate_reindex.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,8 +17,8 @@
"methods": ["POST"],
"parts": {
"index": {
"type": "string",
"description": "The index or data stream name"
"type": "list",
"description": "Comma-separated list of index or data stream names"
}
}
}
Expand Down
4 changes: 2 additions & 2 deletions specification/_json_spec/indices.delete_index_template.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,8 +16,8 @@
"methods": ["DELETE"],
"parts": {
"name": {
"type": "string",
"description": "The name of the template"
"type": "list",
"description": "Comma-separated list of index template names used to limit the request. Wildcard (*) expressions are supported."
}
}
}
Expand Down
4 changes: 2 additions & 2 deletions specification/_json_spec/indices.disk_usage.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,8 +16,8 @@
"methods": ["POST"],
"parts": {
"index": {
"type": "string",
"description": "Comma-separated list of indices or data streams to analyze the disk usage"
"type": "list",
"description": "Comma-separated list of data streams, indices, and aliases used to limit the request. It\u2019s recommended to execute this API with a single index (or the latest backing index of a data stream) as the API consumes resources significantly."
}
}
}
Expand Down
4 changes: 2 additions & 2 deletions specification/_json_spec/indices.explain_data_lifecycle.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,8 +16,8 @@
"methods": ["GET"],
"parts": {
"index": {
"type": "string",
"description": "The name of the index to explain"
"type": "list",
"description": "Comma-separated list of index names to explain"
}
}
}
Expand Down
4 changes: 2 additions & 2 deletions specification/_json_spec/indices.field_usage_stats.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,8 +16,8 @@
"methods": ["GET"],
"parts": {
"index": {
"type": "string",
"description": "A comma-separated list of index names; use `_all` or empty string to perform the operation on all indices"
"type": "list",
"description": "Comma-separated list or wildcard expression of index names used to limit the request."
}
}
}
Expand Down
4 changes: 2 additions & 2 deletions specification/_json_spec/indices.get_data_stream_mappings.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,8 +16,8 @@
"methods": ["GET"],
"parts": {
"name": {
"type": "string",
"description": "Comma-separated list of data streams or data stream patterns"
"type": "list",
"description": "A comma-separated list of data streams or data stream patterns. Supports wildcards (`*`)."
}
}
}
Expand Down
4 changes: 2 additions & 2 deletions specification/_json_spec/indices.get_data_stream_settings.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,8 +16,8 @@
"methods": ["GET"],
"parts": {
"name": {
"type": "string",
"description": "Comma-separated list of data streams or data stream patterns"
"type": "list",
"description": "A comma-separated list of data streams or data stream patterns. Supports wildcards (`*`)."
}
}
}
Expand Down
4 changes: 2 additions & 2 deletions specification/_json_spec/indices.get_migrate_reindex_status.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,8 +17,8 @@
"methods": ["GET"],
"parts": {
"index": {
"type": "string",
"description": "The index or data stream name"
"type": "list",
"description": "Comma-separated list of index or data stream names."
}
}
}
Expand Down
4 changes: 2 additions & 2 deletions specification/_json_spec/indices.put_data_stream_mappings.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,8 +16,8 @@
"methods": ["PUT"],
"parts": {
"name": {
"type": "string",
"description": "Comma-separated list of data streams or data stream patterns"
"type": "list",
"description": "A comma-separated list of data streams or data stream patterns."
}
}
}
Expand Down
4 changes: 2 additions & 2 deletions specification/_json_spec/indices.put_data_stream_settings.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,8 +16,8 @@
"methods": ["PUT"],
"parts": {
"name": {
"type": "string",
"description": "Comma-separated list of data streams or data stream patterns"
"type": "list",
"description": "A comma-separated list of data streams or data stream patterns."
}
}
}
Expand Down
4 changes: 2 additions & 2 deletions specification/_json_spec/logstash.get_pipeline.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,8 +20,8 @@
"methods": ["GET"],
"parts": {
"id": {
"type": "string",
"description": "A comma-separated list of Pipeline IDs"
"type": "list",
"description": "A comma-separated list of pipeline identifiers."
}
}
}
Expand Down
2 changes: 1 addition & 1 deletion specification/_json_spec/mget.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,7 @@
"description": "Refresh the shard containing the document before performing the operation"
},
"routing": {
"type": "string",
"type": "list",
"description": "Specific routing value"
},
"_source": {
Expand Down
4 changes: 2 additions & 2 deletions specification/_json_spec/ml.delete_calendar_job.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,8 +20,8 @@
"description": "The ID of the calendar to modify"
},
"job_id": {
"type": "string",
"description": "The ID of the job to remove from the calendar"
"type": "list",
"description": "An identifier for the anomaly detection jobs. It can be a job identifier, a group name, or a comma-separated list of jobs or groups."
}
}
}
Expand Down
4 changes: 2 additions & 2 deletions specification/_json_spec/ml.get_datafeed_stats.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,8 +16,8 @@
"methods": ["GET"],
"parts": {
"datafeed_id": {
"type": "string",
"description": "The ID of the datafeeds stats to fetch"
"type": "list",
"description": "Comma-separated list of datafeed identifiers or wildcard expressions. If you do not specify one of these options, the API returns information about all datafeeds."
}
}
},
Expand Down
4 changes: 2 additions & 2 deletions specification/_json_spec/ml.get_datafeeds.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,8 +16,8 @@
"methods": ["GET"],
"parts": {
"datafeed_id": {
"type": "string",
"description": "The ID of the datafeeds to fetch"
"type": "list",
"description": "Identifier for the datafeed. It can be a datafeed identifier or a wildcard expression. If you do not specify one of these options, the API returns information about all datafeeds."
}
}
},
Expand Down
4 changes: 2 additions & 2 deletions specification/_json_spec/ml.get_filters.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,8 +20,8 @@
"methods": ["GET"],
"parts": {
"filter_id": {
"type": "string",
"description": "The ID of the filter to fetch"
"type": "list",
"description": "Comma-separated list of strings that uniquely identify a filter."
}
}
}
Expand Down
4 changes: 2 additions & 2 deletions specification/_json_spec/ml.get_jobs.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,8 +16,8 @@
"methods": ["GET"],
"parts": {
"job_id": {
"type": "string",
"description": "The ID of the jobs to fetch"
"type": "list",
"description": "Comma-separated list of identifiers for the anomaly detection job. It can be a job identifier, a group name, or a wildcard expression. If you do not specify one of these options, the API returns information for all anomaly detection jobs."
}
}
},
Expand Down
4 changes: 2 additions & 2 deletions specification/_json_spec/ml.get_trained_models.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,8 +16,8 @@
"methods": ["GET"],
"parts": {
"model_id": {
"type": "string",
"description": "The ID of the trained models to fetch"
"type": "list",
"description": "The unique identifier of the trained model or a model alias. You can get information for multiple trained models in a single API request by using a comma-separated list of model IDs or a wildcard expression."
}
}
},
Expand Down
Loading