Skip to content

Update rest-api-spec main #3263

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
Jan 22, 2025
Merged

Update rest-api-spec main #3263

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
21 changes: 2 additions & 19 deletions output/schema/validation-errors.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -237,8 +237,7 @@
},
"indices.rollover": {
"request": [
"Request: missing json spec query parameter 'lazy'",
"Request: missing json spec query parameter 'target_failure_store'"
"Request: missing json spec query parameter 'lazy'"
],
"response": []
},
Expand All @@ -264,8 +263,7 @@
"license.post_start_trial": {
"request": [
"Request: query parameter 'type_query_string' does not exist in the json spec",
"Request: missing json spec query parameter 'type'",
"Request: missing json spec query parameter 'timeout'"
"Request: missing json spec query parameter 'type'"
],
"response": []
},
Expand Down Expand Up @@ -356,20 +354,6 @@
],
"response": []
},
"shutdown.delete_node": {
"request": [
"Request: query parameter 'master_timeout' does not exist in the json spec",
"Request: query parameter 'timeout' does not exist in the json spec"
],
"response": []
},
"shutdown.put_node": {
"request": [
"Request: query parameter 'master_timeout' does not exist in the json spec",
"Request: query parameter 'timeout' does not exist in the json spec"
],
"response": []
},
"snapshot.clone": {
"request": [
"Request: query parameter 'timeout' does not exist in the json spec"
Expand Down Expand Up @@ -411,7 +395,6 @@
},
"xpack.info": {
"request": [
"Request: query parameter 'human' does not exist in the json spec",
"request definition xpack.info:Request / query - Property 'human' is already defined in an ancestor class"
],
"response": []
Expand Down
3 changes: 2 additions & 1 deletion 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 @@ -26,9 +26,10 @@
"params": {
"master_timeout": {
"type": "time",
"description": "Explicit operation timeout for connection to master node"
"description": "Timeout for waiting for new cluster state in case it is blocked"
},
"local": {
"deprecated": true,
"type": "boolean",
"description": "Return local information, do not retrieve the state from master node (default: false)"
}
Expand Down
3 changes: 2 additions & 1 deletion specification/_json_spec/cluster.get_component_template.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,9 +30,10 @@
"params": {
"master_timeout": {
"type": "time",
"description": "Explicit operation timeout for connection to master node"
"description": "Timeout for waiting for new cluster state in case it is blocked"
},
"local": {
"deprecated": true,
"type": "boolean",
"description": "Return local information, do not retrieve the state from master node (default: false)"
},
Expand Down
2 changes: 1 addition & 1 deletion specification/_json_spec/cluster.get_settings.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@
},
"master_timeout": {
"type": "time",
"description": "Explicit operation timeout for connection to master node"
"description": "Timeout for waiting for new cluster state in case it is blocked"
},
"timeout": {
"type": "time",
Expand Down
8 changes: 4 additions & 4 deletions specification/_json_spec/connector.delete.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,15 +24,15 @@
]
},
"params": {
"delete_sync_jobs": {
"hard": {
"type": "boolean",
"default": false,
"description": "Determines whether associated sync jobs are also deleted."
"description": "If true, the connector doc is deleted. If false, connector doc is marked as deleted (soft-deleted)."
},
"hard": {
"delete_sync_jobs": {
"type": "boolean",
"default": false,
"description": "A flag indicating if this should be a hard delete. Defaults to false."
"description": "Determines whether associated sync jobs are also deleted."
}
}
}
Expand Down
2 changes: 1 addition & 1 deletion specification/_json_spec/connector.get.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@
"include_deleted": {
"type": "boolean",
"default": false,
"description": "A flag to indicate if the desired connector should be fetched even if it was soft-deleted"
"description": "A flag indicating whether to return connectors that have been soft-deleted."
}
}
}
Expand Down
2 changes: 1 addition & 1 deletion specification/_json_spec/connector.list.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@
"include_deleted": {
"type": "boolean",
"default": false,
"description": "A flag that indicates whether a soft-deleted connectors will be fetched"
"description": "A flag indicating whether to return connectors that have been soft-deleted."
}
}
}
Expand Down
3 changes: 2 additions & 1 deletion specification/_json_spec/indices.exists_template.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,9 +30,10 @@
},
"master_timeout": {
"type": "time",
"description": "Explicit operation timeout for connection to master node"
"description": "Timeout for waiting for new cluster state in case it is blocked"
},
"local": {
"deprecated": true,
"type": "boolean",
"description": "Return local information, do not retrieve the state from master node (default: false)"
}
Expand Down
3 changes: 2 additions & 1 deletion specification/_json_spec/indices.get_index_template.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,9 +34,10 @@
},
"master_timeout": {
"type": "time",
"description": "Explicit operation timeout for connection to master node"
"description": "Timeout for waiting for new cluster state in case it is blocked"
},
"local": {
"deprecated": true,
"type": "boolean",
"description": "Return local information, do not retrieve the state from master node (default: false)"
},
Expand Down
3 changes: 2 additions & 1 deletion specification/_json_spec/indices.get_template.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,9 +34,10 @@
},
"master_timeout": {
"type": "time",
"description": "Explicit operation timeout for connection to master node"
"description": "Timeout for waiting for new cluster state in case it is blocked"
},
"local": {
"deprecated": true,
"type": "boolean",
"description": "Return local information, do not retrieve the state from master node (default: false)"
}
Expand Down
6 changes: 0 additions & 6 deletions specification/_json_spec/indices.rollover.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -59,12 +59,6 @@
"type": "boolean",
"default": "false",
"description": "If set to true, the rollover action will only mark a data stream to signal that it needs to be rolled over at the next write. Only allowed on data streams."
},
"target_failure_store": {
"type": "boolean",
"description": "If set to true, the rollover action will be applied on the failure store of the data stream.",
"visibility": "feature_flag",
"feature_flag": "es.failure_store_feature_flag_enabled"
}
},
"body": {
Expand Down
4 changes: 0 additions & 4 deletions specification/_json_spec/license.post_start_trial.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,10 +29,6 @@
"master_timeout": {
"type": "time",
"description": "Timeout for processing on master node"
},
"timeout": {
"type": "time",
"description": "Timeout for acknowledgement of update from all nodes in cluster"
}
}
}
Expand Down
2 changes: 1 addition & 1 deletion specification/_json_spec/migrate.cancel_reindex.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
"migrate.cancel_reindex": {
"documentation": {
"url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/data-stream-reindex.html",
"description": "This API cancels migration reindex attempt for a data stream or index"
"description": "This API returns the status of a migration reindex attempt for a data stream or index"
},
"stability": "experimental",
"visibility": "private",
Expand Down
2 changes: 1 addition & 1 deletion specification/_json_spec/migrate.create_from.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@
]
},
"body": {
"description": "The body contains the fields `mappings_override` and `settings_override`.",
"description": "The body contains the fields `mappings_override`, `settings_override`, and `remove_index_blocks`.",
"required": false
}
}
Expand Down
2 changes: 1 addition & 1 deletion specification/_json_spec/migrate.reindex.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@
]
},
"body": {
"description": "The body contains the fields `mode` and `source.index`, where the only mode currently supported is `upgrade`, and the `source.index` must be a data stream name",
"description": "The body contains the fields `mode` and `source.index, where the only mode currently supported is `upgrade`, and the `source.index` must be a data stream name",
"required": true
}
}
Expand Down
11 changes: 10 additions & 1 deletion specification/_json_spec/shutdown.delete_node.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,15 @@
}
]
},
"params": {}
"params": {
"master_timeout": {
"type": "time",
"description": "Explicit operation timeout for connection to master node"
},
"timeout": {
"type": "time",
"description": "Explicit operation timeout"
}
}
}
}
11 changes: 10 additions & 1 deletion specification/_json_spec/shutdown.put_node.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,16 @@
}
]
},
"params": {},
"params": {
"master_timeout": {
"type": "time",
"description": "Explicit operation timeout for connection to master node"
},
"timeout": {
"type": "time",
"description": "Explicit operation timeout"
}
},
"body": {
"description": "The shutdown type definition to register",
"required": true
Expand Down
6 changes: 6 additions & 0 deletions specification/_json_spec/xpack.info.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,12 @@
]
},
"params": {
"human": {
"type": "boolean",
"required": false,
"description": "Defines whether additional human-readable information is included in the response. In particular, it adds descriptions and a tag line. The default value is true.",
"default": true
},
"categories": {
"type": "list",
"description": "Comma-separated list of info categories. Can be any of: build, license, features"
Expand Down
Loading