Skip to content

[9.2] rest-api-spec: use list type in parts when appropriate (#137568) #138154

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
merged 1 commit into from
Nov 17, 2025
Merged

[9.2] rest-api-spec: use list type in parts when appropriate (#137568) #138154

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 rest-api-spec/src/main/resources/rest-api-spec/api/cluster.delete_component_template.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,8 +20,8 @@
],
"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 rest-api-spec/src/main/resources/rest-api-spec/api/cluster.exists_component_template.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,8 +20,8 @@
],
"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
4 changes: 2 additions & 2 deletions rest-api-spec/src/main/resources/rest-api-spec/api/eql.search.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,8 +24,8 @@
],
"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
4 changes: 2 additions & 2 deletions rest-api-spec/src/main/resources/rest-api-spec/api/health_report.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,8 +26,8 @@
],
"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
4 changes: 2 additions & 2 deletions rest-api-spec/src/main/resources/rest-api-spec/api/indices.cancel_migrate_reindex.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,8 +23,8 @@
],
"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 rest-api-spec/src/main/resources/rest-api-spec/api/indices.delete_index_template.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,8 +20,8 @@
],
"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 rest-api-spec/src/main/resources/rest-api-spec/api/indices.disk_usage.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,8 +20,8 @@
],
"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 rest-api-spec/src/main/resources/rest-api-spec/api/indices.explain_data_lifecycle.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,8 +20,8 @@
],
"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 rest-api-spec/src/main/resources/rest-api-spec/api/indices.field_usage_stats.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,8 +20,8 @@
],
"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 rest-api-spec/src/main/resources/rest-api-spec/api/indices.get_data_stream_mappings.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,8 +20,8 @@
],
"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 rest-api-spec/src/main/resources/rest-api-spec/api/indices.get_data_stream_settings.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,8 +20,8 @@
],
"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 rest-api-spec/src/main/resources/rest-api-spec/api/indices.get_migrate_reindex_status.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,8 +23,8 @@
],
"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 rest-api-spec/src/main/resources/rest-api-spec/api/indices.put_data_stream_mappings.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,8 +20,8 @@
],
"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 rest-api-spec/src/main/resources/rest-api-spec/api/indices.put_data_stream_settings.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,8 +20,8 @@
],
"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 rest-api-spec/src/main/resources/rest-api-spec/api/logstash.get_pipeline.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,8 +26,8 @@
],
"parts": {
"id": {
"type": "string",
"description": "A comma-separated list of Pipeline IDs"
"type": "list",
"description": "A comma-separated list of pipeline identifiers."
}
}
}
Expand Down
4 changes: 2 additions & 2 deletions rest-api-spec/src/main/resources/rest-api-spec/api/ml.delete_calendar_job.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,8 +24,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 rest-api-spec/src/main/resources/rest-api-spec/api/ml.get_datafeed_stats.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,8 +20,8 @@
],
"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 rest-api-spec/src/main/resources/rest-api-spec/api/ml.get_datafeeds.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,8 +20,8 @@
],
"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 rest-api-spec/src/main/resources/rest-api-spec/api/ml.get_filters.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,8 +26,8 @@
],
"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 rest-api-spec/src/main/resources/rest-api-spec/api/ml.get_jobs.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,8 +20,8 @@
],
"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 rest-api-spec/src/main/resources/rest-api-spec/api/ml.get_trained_models.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,8 +20,8 @@
],
"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
4 changes: 2 additions & 2 deletions rest-api-spec/src/main/resources/rest-api-spec/api/ml.get_trained_models_stats.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,8 +20,8 @@
],
"parts": {
"model_id": {
"type": "string",
"description": "The ID of the trained models stats to fetch"
"type": "list",
"description": "The unique identifier of the trained model or a model alias. It can be a comma-separated list or a wildcard expression."
}
}
},
Expand Down
4 changes: 2 additions & 2 deletions rest-api-spec/src/main/resources/rest-api-spec/api/ml.put_calendar_job.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,8 +24,8 @@
"description": "The ID of the calendar to modify"
},
"job_id": {
"type": "string",
"description": "The ID of the job to add to 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 rest-api-spec/src/main/resources/rest-api-spec/api/rollup.get_rollup_index_caps.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,8 +24,8 @@
],
"parts": {
"index": {
"type": "string",
"description": "The rollup index or index pattern to obtain rollup capabilities from."
"type": "list",
"description": "Comma-separated list of data streams or indices to check for rollup capabilities. Wildcard (`*`) expressions are supported."
}
}
}
Expand Down
4 changes: 2 additions & 2 deletions rest-api-spec/src/main/resources/rest-api-spec/api/security.delete_privileges.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,8 +24,8 @@
"description": "Application name"
},
"name": {
"type": "string",
"description": "Privilege name"
"type": "list",
"description": "Comma-separated list of privilege names."
}
}
}
Expand Down
4 changes: 2 additions & 2 deletions rest-api-spec/src/main/resources/rest-api-spec/api/security.get_privileges.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,8 +42,8 @@
"description": "Application name"
},
"name": {
"type": "string",
"description": "Privilege name"
"type": "list",
"description": "Comma-separated list of privilege names. If you do not specify this parameter, the API returns information about all privileges for the requested application."
}
}
}
Expand Down
4 changes: 2 additions & 2 deletions rest-api-spec/src/main/resources/rest-api-spec/api/shutdown.get_node.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,8 +29,8 @@
],
"parts": {
"node_id": {
"type": "string",
"description": "Which node for which to retrieve the shutdown status"
"type": "list",
"description": "Comma-separated list of nodes for which to retrieve the shutdown status"
}
}
}
Expand Down
4 changes: 2 additions & 2 deletions rest-api-spec/src/main/resources/rest-api-spec/api/snapshot.repository_verify_integrity.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,8 +20,8 @@
],
"parts": {
"repository": {
"type": "string",
"description": "A repository name"
"type": "list",
"description": "Comma-separated list of snapshot repository names."
}
}
}
Expand Down
4 changes: 2 additions & 2 deletions rest-api-spec/src/main/resources/rest-api-spec/api/transform.get_transform.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,8 +20,8 @@
],
"parts": {
"transform_id": {
"type": "string",
"description": "The id or comma delimited list of id expressions of the transforms to get, '_all' or '*' implies get all transforms"
"type": "list",
"description": "Comma-separated list of transform identifiers or wildcard expressions. You can get information for all transforms by using `_all`, by specifying `*` as the `<transform_id>`, or by omitting the `<transform_id>`."
}
}
},
Expand Down
4 changes: 2 additions & 2 deletions rest-api-spec/src/main/resources/rest-api-spec/api/transform.get_transform_stats.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,8 +20,8 @@
],
"parts": {
"transform_id": {
"type": "string",
"description": "The id of the transform for which to get stats. '_all' or '*' implies all transforms"
"type": "list",
"description": "Comma-separated list of transform identifiers or wildcard expressions. You can get information for all transforms by using `_all`, by specifying `*` as the `<transform_id>`, or by omitting the `<transform_id>`."
}
}
}
Expand Down