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

[Backport 8.17] [DOCS] Edit ingest ip_location summaries #3395

Merged
merged 2 commits into from
Jan 7, 2025
Merged

[Backport 8.17] [DOCS] Edit ingest ip_location summaries #3395

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
76658bf
[DOCS] Edit ingest ip_location summaries (#3390)
lcawl Dec 31, 2024
941e61f
Regenerate output
lcawl Dec 31, 2024
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
28 changes: 14 additions & 14 deletions output/openapi/elasticsearch-openapi.json
View file
Open in desktop

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

53 changes: 34 additions & 19 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.

4 changes: 2 additions & 2 deletions specification/ingest/_types/Database.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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 {
Expand Down
15 changes: 10 additions & 5 deletions specification/ingest/delete_ip_location_database/DeleteIpLocationDatabaseRequest.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
}
Expand Down
6 changes: 4 additions & 2 deletions specification/ingest/get_ip_location_database/GetIpLocationDatabaseRequest.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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: {
Expand All @@ -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
}
Expand Down
4 changes: 2 additions & 2 deletions specification/ingest/put_geoip_database/PutGeoipDatabaseRequest.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
Loading
Loading