[DOCS] Edit ingest ip_location summaries (#3390)

Co-authored-by: shainaraskas <[email protected]>
elastic · Dec 31, 2024 · 60ad301 · 60ad301
1 parent 9a0db4c
commit 60ad301
Show file tree

Hide file tree

Showing 7 changed files with 74 additions and 48 deletions.
diff --git a/output/openapi/elasticsearch-openapi.json b/output/openapi/elasticsearch-openapi.json
diff --git a/output/schema/schema.json b/output/schema/schema.json
diff --git 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
@@ -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
@@ -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
@@ -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