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.

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

[DOCS] Edit text structure summaries #3344

Merged
merged 2 commits into from
Dec 18, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
18 changes: 13 additions & 5 deletions output/openapi/elasticsearch-openapi.json

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

21 changes: 14 additions & 7 deletions output/schema/schema.json

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

1 change: 1 addition & 0 deletions specification/_doc_ids/table.csv
Original file line number Diff line number Diff line change
Expand Up @@ -194,6 +194,7 @@ get-transform,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/g
get-trial-status,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/get-trial-status.html
graph,https://www.elastic.co/guide/en/kibana/{branch}/xpack-graph.html
graph-explore-api,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/graph-explore-api.html
grok,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/grok.html
grok-processor,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/grok-processor.html
gsub-processor,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/gsub-processor.html
ilm-delete-lifecycle,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/ilm-delete-lifecycle.html
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -22,9 +22,27 @@ import { uint } from '@_types/Numeric'
import { Duration } from '@_types/Time'

/**
* Find the structure of a text file.
* The text file must contain data that is suitable to be ingested into Elasticsearch.
*
* 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.
* Unlike other Elasticsearch endpoints, the data that is posted to this endpoint does not need to be UTF-8 encoded and in JSON format.
* It must, however, be text; binary text formats are not currently supported.
* The size is limited to the Elasticsearch HTTP receive buffer size, which defaults to 100 Mb.
*
* The response from the API contains:
*
* * A couple of messages from the beginning of the text.
* * Statistics that reveal the most common values for all fields detected within the text and basic numeric statistics for numeric fields.
* * Information about the structure of the text, which is useful when you write ingest configurations to index it or similarly formatted text.
* * Appropriate mappings for an Elasticsearch index, which you could use to ingest the text.
*
* All this information can be calculated by the structure finder with no guidance.
* However, you can optionally override some of the decisions about the text structure by specifying one or more query parameters.
* @rest_spec_name text_structure.find_structure
* @availability stack since=7.13.0 stability=stable
* @availability serverless stability=stable visibility=private
* @cluster_privileges monitor_text_structure
*/
export interface Request<TJsonDocument> {
query_parameters: {
Expand All @@ -38,6 +56,7 @@ export interface Request<TJsonDocument> {
ecs_compatibility?: string
/**
* 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.
* If the structure finder produces unexpected results for some text, use this query parameter to help you determine why the returned structure was chosen.
* @server_default false
*/
explain?: boolean
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -21,9 +21,13 @@ import { RequestBase } from '@_types/Base'
import { GrokPattern } from '@_types/common'

/**
* Test a Grok pattern.
* Test a Grok pattern on one or more lines of text.
* The API indicates whether the lines match the pattern together with the offsets and lengths of the matched substrings.
* @rest_spec_name text_structure.test_grok_pattern
* @availability stack since=8.13.0 stability=stable
* @availability serverless stability=stable visibility=private
* @ext_doc_id grok
*/
export interface Request extends RequestBase {
query_parameters: {
Expand Down
Loading