Skip to content

Commit 60ad301

Browse files
lcawlshainaraskas
andauthored
[DOCS] Edit ingest ip_location summaries (#3390)
Co-authored-by: shainaraskas <58563081+shainaraskas@users.noreply.github.com>
1 parent 9a0db4c commit 60ad301

File tree

7 files changed

+74
-48
lines changed

7 files changed

+74
-48
lines changed

output/openapi/elasticsearch-openapi.json

Lines changed: 14 additions & 14 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

output/schema/schema.json

Lines changed: 34 additions & 19 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

specification/ingest/_types/Database.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -21,8 +21,8 @@ import { Id, Name } from '@_types/common'
2121

2222
/**
2323
* 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.
24-
* At present, the only supported providers are maxmind and ipinfo, and the maxmind provider requires that an account_id (string) is configured.
25-
* A provider (either maxmind or ipinfo) must be specified. The web and local providers can be returned as read only configurations.
24+
* At present, the only supported providers are `maxmind` and `ipinfo`, and the `maxmind` provider requires that an `account_id` (string) is configured.
25+
* A provider (either `maxmind` or `ipinfo`) must be specified. The web and local providers can be returned as read only configurations.
2626
* @variants container
2727
*/
2828
export class DatabaseConfiguration {

specification/ingest/delete_ip_location_database/DeleteIpLocationDatabaseRequest.ts

Lines changed: 10 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -22,26 +22,31 @@ import { Ids } from '@_types/common'
2222
import { Duration } from '@_types/Time'
2323

2424
/**
25-
* Deletes an IP location database configuration.
25+
* Delete IP geolocation database configurations.
2626
* @rest_spec_name ingest.delete_ip_location_database
2727
* @availability stack since=8.15.0 stability=stable
2828
* @availability serverless visibility=private
29+
* @cluster_privileges manage
2930
*/
3031
export interface Request extends RequestBase {
3132
path_parts: {
3233
/**
33-
* A comma-separated list of IP location database configurations to delete
34+
* A comma-separated list of IP location database configurations.
3435
*/
3536
id: Ids
3637
}
3738
query_parameters: {
3839
/**
39-
* Period to wait for a connection to the master node.
40+
* The period to wait for a connection to the master node.
4041
* If no response is received before the timeout expires, the request fails and returns an error.
41-
* @server_default 30s */
42+
* A value of `-1` indicates that the request should never time out.
43+
* @server_default 30s
44+
*/
4245
master_timeout?: Duration
4346
/**
44-
* Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error.
47+
* The period to wait for a response.
48+
* If no response is received before the timeout expires, the request fails and returns an error.
49+
* A value of `-1` indicates that the request should never time out.
4550
* @server_default 30s */
4651
timeout?: Duration
4752
}

specification/ingest/get_ip_location_database/GetIpLocationDatabaseRequest.ts

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -22,10 +22,11 @@ import { Ids } from '@_types/common'
2222
import { Duration } from '@_types/Time'
2323

2424
/**
25-
* Returns information about one or more IP location database configurations.
25+
* Get IP geolocation database configurations.
2626
* @rest_spec_name ingest.get_ip_location_database
2727
* @availability stack since=8.15.0 stability=stable
2828
* @availability serverless visibility=private
29+
* @cluster_privileges manage
2930
*/
3031
export interface Request extends RequestBase {
3132
path_parts: {
@@ -38,8 +39,9 @@ export interface Request extends RequestBase {
3839
}
3940
query_parameters: {
4041
/**
41-
* Period to wait for a connection to the master node.
42+
* The period to wait for a connection to the master node.
4243
* If no response is received before the timeout expires, the request fails and returns an error.
44+
* A value of `-1` indicates that the request should never time out.
4345
* @server_default 30s */
4446
master_timeout?: Duration
4547
}

specification/ingest/put_geoip_database/PutGeoipDatabaseRequest.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -23,8 +23,8 @@ import { Id, Name } from '@_types/common'
2323
import { Duration } from '@_types/Time'
2424

2525
/**
26-
* Create or update GeoIP database configurations.
27-
* Create or update IP geolocation database configurations.
26+
* Create or update a GeoIP database configuration.
27+
* Refer to the create or update IP geolocation database configuration API.
2828
* @rest_spec_name ingest.put_geoip_database
2929
* @availability stack since=8.15.0 stability=stable
3030
* @availability serverless visibility=private

0 commit comments

Comments
 (0)