Skip to content

Commit 14ddb71

Browse files
authored
[DOCS] Edit text structure summaries (#3344)
1 parent 2426d4e commit 14ddb71

File tree

5 files changed

+51
-12
lines changed

5 files changed

+51
-12
lines changed

output/openapi/elasticsearch-openapi.json

Lines changed: 13 additions & 5 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: 14 additions & 7 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

specification/_doc_ids/table.csv

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -194,6 +194,7 @@ get-transform,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/g
194194
get-trial-status,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/get-trial-status.html
195195
graph,https://www.elastic.co/guide/en/kibana/{branch}/xpack-graph.html
196196
graph-explore-api,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/graph-explore-api.html
197+
grok,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/grok.html
197198
grok-processor,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/grok-processor.html
198199
gsub-processor,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/gsub-processor.html
199200
ilm-delete-lifecycle,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/ilm-delete-lifecycle.html

specification/text_structure/find_structure/FindStructureRequest.ts

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,9 +22,27 @@ import { uint } from '@_types/Numeric'
2222
import { Duration } from '@_types/Time'
2323

2424
/**
25+
* Find the structure of a text file.
26+
* The text file must contain data that is suitable to be ingested into Elasticsearch.
27+
*
28+
* This API provides a starting point for ingesting data into Elasticsearch in a format that is suitable for subsequent use with other Elastic Stack functionality.
29+
* Unlike other Elasticsearch endpoints, the data that is posted to this endpoint does not need to be UTF-8 encoded and in JSON format.
30+
* It must, however, be text; binary text formats are not currently supported.
31+
* The size is limited to the Elasticsearch HTTP receive buffer size, which defaults to 100 Mb.
32+
*
33+
* The response from the API contains:
34+
*
35+
* * A couple of messages from the beginning of the text.
36+
* * Statistics that reveal the most common values for all fields detected within the text and basic numeric statistics for numeric fields.
37+
* * Information about the structure of the text, which is useful when you write ingest configurations to index it or similarly formatted text.
38+
* * Appropriate mappings for an Elasticsearch index, which you could use to ingest the text.
39+
*
40+
* All this information can be calculated by the structure finder with no guidance.
41+
* However, you can optionally override some of the decisions about the text structure by specifying one or more query parameters.
2542
* @rest_spec_name text_structure.find_structure
2643
* @availability stack since=7.13.0 stability=stable
2744
* @availability serverless stability=stable visibility=private
45+
* @cluster_privileges monitor_text_structure
2846
*/
2947
export interface Request<TJsonDocument> {
3048
query_parameters: {
@@ -38,6 +56,7 @@ export interface Request<TJsonDocument> {
3856
ecs_compatibility?: string
3957
/**
4058
* If this parameter is set to true, the response includes a field named explanation, which is an array of strings that indicate how the structure finder produced its result.
59+
* If the structure finder produces unexpected results for some text, use this query parameter to help you determine why the returned structure was chosen.
4160
* @server_default false
4261
*/
4362
explain?: boolean

specification/text_structure/test_grok_pattern/TestGrokPatternRequest.ts

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -21,9 +21,13 @@ import { RequestBase } from '@_types/Base'
2121
import { GrokPattern } from '@_types/common'
2222

2323
/**
24+
* Test a Grok pattern.
25+
* Test a Grok pattern on one or more lines of text.
26+
* The API indicates whether the lines match the pattern together with the offsets and lengths of the matched substrings.
2427
* @rest_spec_name text_structure.test_grok_pattern
2528
* @availability stack since=8.13.0 stability=stable
2629
* @availability serverless stability=stable visibility=private
30+
* @ext_doc_id grok
2731
*/
2832
export interface Request extends RequestBase {
2933
query_parameters: {

0 commit comments

Comments
 (0)