Skip to content

Update rest-api-spec main #3019

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.

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 2 commits into from
Nov 15, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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

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

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

18 changes: 18 additions & 0 deletions output/schema/validation-errors.json

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

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?

Copy link
Contributor

Choose a reason for hiding this comment

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

In the eventual future, the geoip APIs will be deprecated and removed (there is no plan to do this at the moment, but given the fullness of time it will happen 'one day'), but the ip_location APIs will stay around forever. In the near and intermediate term, it's the same behavior available under two names.

"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
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
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
}
}
}
Loading