diff --git a/output/openapi/elasticsearch-openapi.json b/output/openapi/elasticsearch-openapi.json index 3f2bbbe3dd..115c2eb004 100644 --- a/output/openapi/elasticsearch-openapi.json +++ b/output/openapi/elasticsearch-openapi.json @@ -15700,8 +15700,8 @@ "tags": [ "ingest" ], - "summary": "Create or update GeoIP database configurations", - "description": "Create or update IP geolocation database configurations.", + "summary": "Create or update a GeoIP database configuration", + "description": "Refer to the create or update IP geolocation database configuration API.", "operationId": "ingest-put-geoip-database", "parameters": [ { @@ -15832,7 +15832,7 @@ "tags": [ "ingest" ], - "summary": "Returns information about one or more IP location database configurations", + "summary": "Get IP geolocation database configurations", "operationId": "ingest-get-ip-location-database-1", "parameters": [ { @@ -15853,13 +15853,13 @@ "tags": [ "ingest" ], - "summary": "Returns information about one or more IP location database configurations", + "summary": "Create or update an IP geolocation database configuration", "operationId": "ingest-put-ip-location-database", "parameters": [ { "in": "path", "name": "id", - "description": "ID of the database configuration to create or update.", + "description": "The database configuration identifier.", "required": true, "deprecated": false, "schema": { @@ -15870,7 +15870,7 @@ { "in": "query", "name": "master_timeout", - "description": "Period to wait for a connection to the master node.\nIf no response is received before the timeout expires, the request fails and returns an error.", + "description": "The period to wait for a connection to the master node.\nIf no response is received before the timeout expires, the request fails and returns an error.\nA value of `-1` indicates that the request should never time out.", "deprecated": false, "schema": { "$ref": "#/components/schemas/_types:Duration" @@ -15880,7 +15880,7 @@ { "in": "query", "name": "timeout", - "description": "Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error.", + "description": "The period to wait for a response from all relevant nodes in the cluster after updating the cluster metadata.\nIf no response is received before the timeout expires, the cluster metadata update still applies but the response indicates that it was not completely acknowledged.\nA value of `-1` indicates that the request should never time out.", "deprecated": false, "schema": { "$ref": "#/components/schemas/_types:Duration" @@ -15916,13 +15916,13 @@ "tags": [ "ingest" ], - "summary": "Deletes an IP location database configuration", + "summary": "Delete IP geolocation database configurations", "operationId": "ingest-delete-ip-location-database", "parameters": [ { "in": "path", "name": "id", - "description": "A comma-separated list of IP location database configurations to delete", + "description": "A comma-separated list of IP location database configurations.", "required": true, "deprecated": false, "schema": { @@ -15933,7 +15933,7 @@ { "in": "query", "name": "master_timeout", - "description": "Period to wait for a connection to the master node.\nIf no response is received before the timeout expires, the request fails and returns an error.", + "description": "The period to wait for a connection to the master node.\nIf no response is received before the timeout expires, the request fails and returns an error.\nA value of `-1` indicates that the request should never time out.", "deprecated": false, "schema": { "$ref": "#/components/schemas/_types:Duration" @@ -15943,7 +15943,7 @@ { "in": "query", "name": "timeout", - "description": "Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error.", + "description": "Period to wait for a response.\nIf no response is received before the timeout expires, the request fails and returns an error.\nA value of `-1` indicates that the request should never time out.", "deprecated": false, "schema": { "$ref": "#/components/schemas/_types:Duration" @@ -16228,7 +16228,7 @@ "tags": [ "ingest" ], - "summary": "Returns information about one or more IP location database configurations", + "summary": "Get IP geolocation database configurations", "operationId": "ingest-get-ip-location-database", "parameters": [ { @@ -71204,7 +71204,7 @@ ] }, "ingest._types:DatabaseConfiguration": { - "description": "The configuration necessary to identify which IP geolocation provider to use to download a database, as well as any provider-specific configuration necessary for such downloading.\nAt present, the only supported providers are maxmind and ipinfo, and the maxmind provider requires that an account_id (string) is configured.\nA provider (either maxmind or ipinfo) must be specified. The web and local providers can be returned as read only configurations.", + "description": "The configuration necessary to identify which IP geolocation provider to use to download a database, as well as any provider-specific configuration necessary for such downloading.\nAt present, the only supported providers are `maxmind` and `ipinfo`, and the `maxmind` provider requires that an `account_id` (string) is configured.\nA provider (either `maxmind` or `ipinfo`) must be specified. The web and local providers can be returned as read only configurations.", "allOf": [ { "type": "object", @@ -99600,7 +99600,7 @@ "ingest.get_ip_location_database#master_timeout": { "in": "query", "name": "master_timeout", - "description": "Period to wait for a connection to the master node.\nIf no response is received before the timeout expires, the request fails and returns an error.", + "description": "The period to wait for a connection to the master node.\nIf no response is received before the timeout expires, the request fails and returns an error.\nA value of `-1` indicates that the request should never time out.", "deprecated": false, "schema": { "$ref": "#/components/schemas/_types:Duration" diff --git a/output/schema/schema.json b/output/schema/schema.json index e94235fd62..260a8eb9fd 100644 --- a/output/schema/schema.json +++ b/output/schema/schema.json @@ -8708,9 +8708,14 @@ "stability": "stable" } }, - "description": "Deletes an IP location database configuration.", + "description": "Delete IP geolocation database configurations.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/delete-ip-location-database-api.html", "name": "ingest.delete_ip_location_database", + "privileges": { + "cluster": [ + "manage" + ] + }, "request": { "name": "Request", "namespace": "ingest.delete_ip_location_database" @@ -8857,9 +8862,14 @@ "stability": "stable" } }, - "description": "Returns information about one or more IP location database configurations.", + "description": "Get IP geolocation database configurations.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/get-ip-location-database-api.html", "name": "ingest.get_ip_location_database", + "privileges": { + "cluster": [ + "manage" + ] + }, "request": { "name": "Request", "namespace": "ingest.get_ip_location_database" @@ -8978,7 +8988,7 @@ "stability": "stable" } }, - "description": "Create or update GeoIP database configurations.\nCreate or update IP geolocation database configurations.", + "description": "Create or update a GeoIP database configuration.\nRefer to the create or update IP geolocation database configuration API.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/put-geoip-database-api.html", "name": "ingest.put_geoip_database", "request": { @@ -9015,9 +9025,14 @@ "stability": "stable" } }, - "description": "Returns information about one or more IP location database configurations.", + "description": "Create or update an IP geolocation database configuration.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/put-ip-location-database-api.html", "name": "ingest.put_ip_location_database", + "privileges": { + "cluster": [ + "manage" + ] + }, "request": { "name": "Request", "namespace": "ingest.put_ip_location_database" @@ -143478,7 +143493,7 @@ }, { "kind": "interface", - "description": "The configuration necessary to identify which IP geolocation provider to use to download a database, as well as any provider-specific configuration necessary for such downloading.\nAt present, the only supported providers are maxmind and ipinfo, and the maxmind provider requires that an account_id (string) is configured.\nA provider (either maxmind or ipinfo) must be specified. The web and local providers can be returned as read only configurations.", + "description": "The configuration necessary to identify which IP geolocation provider to use to download a database, as well as any provider-specific configuration necessary for such downloading.\nAt present, the only supported providers are `maxmind` and `ipinfo`, and the `maxmind` provider requires that an `account_id` (string) is configured.\nA provider (either `maxmind` or `ipinfo`) must be specified. The web and local providers can be returned as read only configurations.", "name": { "name": "DatabaseConfiguration", "namespace": "ingest._types" @@ -147674,7 +147689,7 @@ "body": { "kind": "no_body" }, - "description": "Deletes an IP location database configuration.", + "description": "Delete IP geolocation database configurations.", "inherits": { "type": { "name": "RequestBase", @@ -147687,7 +147702,7 @@ }, "path": [ { - "description": "A comma-separated list of IP location database configurations to delete", + "description": "A comma-separated list of IP location database configurations.", "name": "id", "required": true, "type": { @@ -147701,7 +147716,7 @@ ], "query": [ { - "description": "Period to wait for a connection to the master node.\nIf no response is received before the timeout expires, the request fails and returns an error.", + "description": "The period to wait for a connection to the master node.\nIf no response is received before the timeout expires, the request fails and returns an error.\nA value of `-1` indicates that the request should never time out.", "name": "master_timeout", "required": false, "serverDefault": "30s", @@ -147714,7 +147729,7 @@ } }, { - "description": "Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error.", + "description": "Period to wait for a response.\nIf no response is received before the timeout expires, the request fails and returns an error.\nA value of `-1` indicates that the request should never time out.", "name": "timeout", "required": false, "serverDefault": "30s", @@ -147727,7 +147742,7 @@ } } ], - "specLocation": "ingest/delete_ip_location_database/DeleteIpLocationDatabaseRequest.ts#L24-L48" + "specLocation": "ingest/delete_ip_location_database/DeleteIpLocationDatabaseRequest.ts#L24-L53" }, { "kind": "response", @@ -148284,7 +148299,7 @@ "body": { "kind": "no_body" }, - "description": "Returns information about one or more IP location database configurations.", + "description": "Get IP geolocation database configurations.", "inherits": { "type": { "name": "RequestBase", @@ -148311,7 +148326,7 @@ ], "query": [ { - "description": "Period to wait for a connection to the master node.\nIf no response is received before the timeout expires, the request fails and returns an error.", + "description": "The period to wait for a connection to the master node.\nIf no response is received before the timeout expires, the request fails and returns an error.\nA value of `-1` indicates that the request should never time out.", "name": "master_timeout", "required": false, "serverDefault": "30s", @@ -148324,7 +148339,7 @@ } } ], - "specLocation": "ingest/get_ip_location_database/GetIpLocationDatabaseRequest.ts#L24-L46" + "specLocation": "ingest/get_ip_location_database/GetIpLocationDatabaseRequest.ts#L24-L48" }, { "kind": "response", @@ -148537,7 +148552,7 @@ } ] }, - "description": "Create or update GeoIP database configurations.\nCreate or update IP geolocation database configurations.", + "description": "Create or update a GeoIP database configuration.\nRefer to the create or update IP geolocation database configuration API.", "inherits": { "type": { "name": "RequestBase", @@ -148626,7 +148641,7 @@ } } }, - "description": "Returns information about one or more IP location database configurations.", + "description": "Create or update an IP geolocation database configuration.", "inherits": { "type": { "name": "RequestBase", @@ -148639,7 +148654,7 @@ }, "path": [ { - "description": "ID of the database configuration to create or update.", + "description": "The database configuration identifier.", "name": "id", "required": true, "type": { @@ -148653,7 +148668,7 @@ ], "query": [ { - "description": "Period to wait for a connection to the master node.\nIf no response is received before the timeout expires, the request fails and returns an error.", + "description": "The period to wait for a connection to the master node.\nIf no response is received before the timeout expires, the request fails and returns an error.\nA value of `-1` indicates that the request should never time out.", "name": "master_timeout", "required": false, "serverDefault": "30s", @@ -148666,7 +148681,7 @@ } }, { - "description": "Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error.", + "description": "The period to wait for a response from all relevant nodes in the cluster after updating the cluster metadata.\nIf no response is received before the timeout expires, the cluster metadata update still applies but the response indicates that it was not completely acknowledged.\nA value of `-1` indicates that the request should never time out.", "name": "timeout", "required": false, "serverDefault": "30s", @@ -148679,7 +148694,7 @@ } } ], - "specLocation": "ingest/put_ip_location_database/PutIpLocationDatabaseRequest.ts#L25-L51" + "specLocation": "ingest/put_ip_location_database/PutIpLocationDatabaseRequest.ts#L25-L55" }, { "kind": "response", diff --git a/specification/ingest/_types/Database.ts b/specification/ingest/_types/Database.ts index bb3a9e4475..0db464b6c4 100644 --- a/specification/ingest/_types/Database.ts +++ b/specification/ingest/_types/Database.ts @@ -21,8 +21,8 @@ import { Id, Name } from '@_types/common' /** * The configuration necessary to identify which IP geolocation provider to use to download a database, as well as any provider-specific configuration necessary for such downloading. - * At present, the only supported providers are maxmind and ipinfo, and the maxmind provider requires that an account_id (string) is configured. - * A provider (either maxmind or ipinfo) must be specified. The web and local providers can be returned as read only configurations. + * At present, the only supported providers are `maxmind` and `ipinfo`, and the `maxmind` provider requires that an `account_id` (string) is configured. + * A provider (either `maxmind` or `ipinfo`) must be specified. The web and local providers can be returned as read only configurations. * @variants container */ export class DatabaseConfiguration { diff --git a/specification/ingest/delete_ip_location_database/DeleteIpLocationDatabaseRequest.ts b/specification/ingest/delete_ip_location_database/DeleteIpLocationDatabaseRequest.ts index e582550a23..b81c575294 100644 --- a/specification/ingest/delete_ip_location_database/DeleteIpLocationDatabaseRequest.ts +++ b/specification/ingest/delete_ip_location_database/DeleteIpLocationDatabaseRequest.ts @@ -22,26 +22,31 @@ import { Ids } from '@_types/common' import { Duration } from '@_types/Time' /** - * Deletes an IP location database configuration. + * Delete IP geolocation database configurations. * @rest_spec_name ingest.delete_ip_location_database * @availability stack since=8.15.0 stability=stable * @availability serverless visibility=private + * @cluster_privileges manage */ export interface Request extends RequestBase { path_parts: { /** - * A comma-separated list of IP location database configurations to delete + * A comma-separated list of IP location database configurations. */ id: Ids } query_parameters: { /** - * Period to wait for a connection to the master node. + * The period to wait for a connection to the master node. * If no response is received before the timeout expires, the request fails and returns an error. - * @server_default 30s */ + * A value of `-1` indicates that the request should never time out. + * @server_default 30s + */ master_timeout?: Duration /** - * Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error. + * The period to wait for a response. + * If no response is received before the timeout expires, the request fails and returns an error. + * A value of `-1` indicates that the request should never time out. * @server_default 30s */ timeout?: Duration } diff --git a/specification/ingest/get_ip_location_database/GetIpLocationDatabaseRequest.ts b/specification/ingest/get_ip_location_database/GetIpLocationDatabaseRequest.ts index 41e4700f37..68015635cd 100644 --- a/specification/ingest/get_ip_location_database/GetIpLocationDatabaseRequest.ts +++ b/specification/ingest/get_ip_location_database/GetIpLocationDatabaseRequest.ts @@ -22,10 +22,11 @@ import { Ids } from '@_types/common' import { Duration } from '@_types/Time' /** - * Returns information about one or more IP location database configurations. + * Get IP geolocation database configurations. * @rest_spec_name ingest.get_ip_location_database * @availability stack since=8.15.0 stability=stable * @availability serverless visibility=private + * @cluster_privileges manage */ export interface Request extends RequestBase { path_parts: { @@ -38,8 +39,9 @@ export interface Request extends RequestBase { } query_parameters: { /** - * Period to wait for a connection to the master node. + * The period to wait for a connection to the master node. * If no response is received before the timeout expires, the request fails and returns an error. + * A value of `-1` indicates that the request should never time out. * @server_default 30s */ master_timeout?: Duration } diff --git a/specification/ingest/put_geoip_database/PutGeoipDatabaseRequest.ts b/specification/ingest/put_geoip_database/PutGeoipDatabaseRequest.ts index 9816b2fb7b..565253de7a 100644 --- a/specification/ingest/put_geoip_database/PutGeoipDatabaseRequest.ts +++ b/specification/ingest/put_geoip_database/PutGeoipDatabaseRequest.ts @@ -23,8 +23,8 @@ import { Id, Name } from '@_types/common' import { Duration } from '@_types/Time' /** - * Create or update GeoIP database configurations. - * Create or update IP geolocation database configurations. + * Create or update a GeoIP database configuration. + * Refer to the create or update IP geolocation database configuration API. * @rest_spec_name ingest.put_geoip_database * @availability stack since=8.15.0 stability=stable * @availability serverless visibility=private diff --git a/specification/ingest/put_ip_location_database/PutIpLocationDatabaseRequest.ts b/specification/ingest/put_ip_location_database/PutIpLocationDatabaseRequest.ts index e27b6ac5c4..143299cad1 100644 --- a/specification/ingest/put_ip_location_database/PutIpLocationDatabaseRequest.ts +++ b/specification/ingest/put_ip_location_database/PutIpLocationDatabaseRequest.ts @@ -23,26 +23,30 @@ import { Id } from '@_types/common' import { Duration } from '@_types/Time' /** - * Returns information about one or more IP location database configurations. + * Create or update an IP geolocation database configuration. * @rest_spec_name ingest.put_ip_location_database * @availability stack since=8.15.0 stability=stable * @availability serverless visibility=private + * @cluster_privileges manage */ export interface Request extends RequestBase { path_parts: { /** - * ID of the database configuration to create or update. + * The database configuration identifier. */ id: Id } query_parameters: { /** - * Period to wait for a connection to the master node. + * The period to wait for a connection to the master node. * If no response is received before the timeout expires, the request fails and returns an error. + * A value of `-1` indicates that the request should never time out. * @server_default 30s */ master_timeout?: Duration /** - * Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error. + * The period to wait for a response from all relevant nodes in the cluster after updating the cluster metadata. + * If no response is received before the timeout expires, the cluster metadata update still applies but the response indicates that it was not completely acknowledged. + * A value of `-1` indicates that the request should never time out. * @server_default 30s */ timeout?: Duration }