Skip to content
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

Jump to bottom

Update rest-api-spec main #3019

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
+219 −24
Open

Update rest-api-spec main #3019

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
10 changes: 7 additions & 3 deletions compiler/package-lock.json
View file
Open in desktop

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

84 changes: 84 additions & 0 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.

32 changes: 31 additions & 1 deletion output/schema/validation-errors.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: 0 additions & 4 deletions specification/_json_spec/cat.aliases.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,10 +32,6 @@
"type": "string",
"description": "a short version of the Accept header, e.g. json, yaml"
},
"local": {
"type": "boolean",
"description": "Return local information, do not retrieve the state from master node (default: false)"
},
"h": {
"type": "list",
"description": "Comma-separated list of column names to display"
Expand Down
2 changes: 1 addition & 1 deletion specification/_json_spec/indices.delete_data_lifecycle.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
"url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/data-streams-delete-lifecycle.html",
"description": "Deletes the data stream lifecycle of the selected data streams."
},
"stability": "experimental",
"stability": "stable",
"visibility": "public",
"headers": {
"accept": ["application/json"]
Expand Down
4 changes: 0 additions & 4 deletions specification/_json_spec/indices.exists_alias.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -51,10 +51,6 @@
"options": ["open", "closed", "hidden", "none", "all"],
"default": "all",
"description": "Whether to expand wildcard expression to concrete indices that are open, closed or both."
},
"local": {
"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/indices.explain_data_lifecycle.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
"url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/data-streams-explain-lifecycle.html",
"description": "Retrieves information about the index's current data stream lifecycle, such as any potential encountered error, time since creation etc."
},
"stability": "experimental",
"stability": "stable",
"visibility": "public",
"headers": {
"accept": ["application/json"]
Expand Down
4 changes: 0 additions & 4 deletions specification/_json_spec/indices.get_alias.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -65,10 +65,6 @@
"options": ["open", "closed", "hidden", "none", "all"],
"default": "all",
"description": "Whether to expand wildcard expression to concrete indices that are open, closed or both."
},
"local": {
"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/indices.get_data_lifecycle.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
"url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/data-streams-get-lifecycle.html",
"description": "Returns the data stream lifecycle of the selected data streams."
},
"stability": "experimental",
"stability": "stable",
"visibility": "public",
"headers": {
"accept": ["application/json"]
Expand Down
2 changes: 1 addition & 1 deletion specification/_json_spec/indices.put_data_lifecycle.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
"url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/data-streams-put-lifecycle.html",
"description": "Updates the data stream lifecycle of the selected data streams."
},
"stability": "experimental",
"stability": "stable",
"visibility": "public",
"headers": {
"accept": ["application/json"]
Expand Down
28 changes: 28 additions & 0 deletions specification/_json_spec/ingest.delete_ip_location_database.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
{
"ingest.delete_ip_location_database": {
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@joegallo I'm slightly confused by those new APIs. Based on https://github.com/elastic/elasticsearch/pull/114548/files#diff-e691792ba34345b9c60eac06a6730438c8265376839f01e598b4f02e39f8a1ac, my understanding is that right now they are strictly equivalent to the GeoIP APIs. Will they do something different at some point? When should we expose them to clients and serverless docs?

"documentation": {
"url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/delete-ip-location-database-api.html",
"description": "Deletes an ip location database configuration"
},
"stability": "stable",
"visibility": "public",
"headers": {
"accept": ["application/json"]
},
"url": {
"paths": [
{
"path": "/_ingest/ip_location/database/{id}",
"methods": ["DELETE"],
"parts": {
"id": {
"type": "list",
"description": "A comma-separated list of ip location database configurations to delete"
}
}
}
]
},
"params": {}
}
}
32 changes: 32 additions & 0 deletions specification/_json_spec/ingest.get_ip_location_database.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
{
"ingest.get_ip_location_database": {
"documentation": {
"url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/get-ip-location-database-api.html",
"description": "Returns the specified ip location database configuration"
},
"stability": "stable",
"visibility": "public",
"headers": {
"accept": ["application/json"]
},
"url": {
"paths": [
{
"path": "/_ingest/ip_location/database",
"methods": ["GET"]
},
{
"path": "/_ingest/ip_location/database/{id}",
"methods": ["GET"],
"parts": {
"id": {
"type": "list",
"description": "A comma-separated list of ip location database configurations to get; use `*` to get all ip location database configurations"
}
}
}
]
},
"params": {}
}
}
33 changes: 33 additions & 0 deletions specification/_json_spec/ingest.put_ip_location_database.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
{
"ingest.put_ip_location_database": {
"documentation": {
"url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/put-ip-location-database-api.html",
"description": "Puts the configuration for a ip location database to be downloaded"
},
"stability": "stable",
"visibility": "public",
"headers": {
"accept": ["application/json"],
"content_type": ["application/json"]
},
"url": {
"paths": [
{
"path": "/_ingest/ip_location/database/{id}",
"methods": ["PUT"],
"parts": {
"id": {
"type": "string",
"description": "The id of the database configuration"
}
}
}
]
},
"params": {},
"body": {
"description": "The database configuration definition",
"required": true
}
}
}
4 changes: 0 additions & 4 deletions specification/_json_spec/search.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -215,10 +215,6 @@
"description": "Indicates whether hits.total should be rendered as an integer or an object in the rest search response",
"default": false
},
"min_compatible_shard_node": {
"type": "string",
"description": "The minimum compatible version that all shards involved in search should have for this request to be successful"
},
"include_named_queries_score": {
"type": "boolean",
"description": "Indicates whether hit.matched_queries should be rendered as a map that includes the name of the matched query associated with its score (true) or as an array containing the name of the matched queries (false)",
Expand Down