Commit graph

257 commits

Author SHA1 Message Date
Nick Tindall
2a327b1125
[DOCS] Fix stored_fields parameter description (#98385) (#108445) (#108447)
(referenced from get and multi_get API docs)

Closes #98385
2024-05-09 03:43:07 -04:00
Przemysław Witek
5f7968f3b3
[Transform] Expand the docs section regarding mappings deduction in transform's dest index (#91077) (#91080) 2022-10-24 08:09:17 -04:00
István Zoltán Szabó
b136b0bcd8
[7.17][DOCS] Adds missing_bucket setting to transform APIs (#90135)
* [7.17][DOCS] Adds missing_bucket setting to transform APIs.

* [DOCS] Expands examples.
2022-09-19 16:36:54 +02:00
Andrey
6d7e2fda60 Remove suggest flag from index stats docs (#85479) 2022-07-14 12:51:37 -04:00
James Rodewig
6961309189
[DOCS] Fix ignore_unavailable parameter definition (#84071) (#84106)
The current `ignore_unavailable` definition is a bit misleading. The parameter primarily determines if a request that targets a missing or closed index returns an error.

(cherry picked from commit f9a64b2e86)
2022-02-17 08:38:11 -05:00
Lisa Cawley
51dffb5c9f
[DOCS] Fix formatting in cat transforms API (#82899) (#82901) 2022-01-20 18:00:54 -08:00
Lisa Cawley
d68c756858
[7.16][DOCS] Move trained model APIs out of dataframe analytics (#81315) (#81324) 2021-12-03 10:42:35 -08:00
Lisa Cawley
66daa10b1c
[DOCS] Adds missing timeout parameter to transform APIs (#81129) (#81278) 2021-12-02 18:35:44 -08:00
James Rodewig
964ece6686
[DOCS] Fix syntax error in bulk dynamic_templates docs (#81264) (#81267) 2021-12-02 14:17:44 -05:00
Lisa Cawley
906eaee2ce
[DOCS] Clarifies transform ID character limit (#81063) 2021-11-25 10:05:14 -08:00
Benjamin Trent
4724553d91
[ML] deprecate estimated_heap_memory_usage_bytes and replace with model_size_bytes (#80545)
This deprecates estimated_heap_memory_usage_bytes on model put and replaces it with model_size_bytes.

On GET, both fields are returned (unless storing in the index) and are populated with the same field.

For the ml/info API, both fields are returned as well.
2021-11-10 11:24:04 -05:00
James Rodewig
07ac8818b6
[DOCS] Remove testenv annotations from doc snippet tests (#80023) (#80458)
Removes `testenv` annotations and related code. These annotations originally let you skip x-pack snippet tests in the docs. However, that's no longer possible.

Relates to #79309, #31619
# Conflicts:
#	docs/reference/ml/df-analytics/apis/get-trained-model-deployment-stats.asciidoc
#	docs/reference/ml/df-analytics/apis/infer-trained-model-deployment.asciidoc
#	docs/reference/ml/df-analytics/apis/put-trained-model-definition-part.asciidoc
#	docs/reference/ml/df-analytics/apis/put-trained-model-vocabulary.asciidoc
#	docs/reference/ml/df-analytics/apis/start-trained-model-deployment.asciidoc
#	docs/reference/ml/df-analytics/apis/stop-trained-model-deployment.asciidoc
#	docs/reference/slm/apis/slm-delete.asciidoc
#	docs/reference/slm/apis/slm-execute-retention.asciidoc
#	docs/reference/slm/apis/slm-execute.asciidoc
#	docs/reference/slm/apis/slm-get-status.asciidoc
#	docs/reference/slm/apis/slm-get.asciidoc
#	docs/reference/slm/apis/slm-start.asciidoc
#	docs/reference/slm/apis/slm-stats.asciidoc
#	docs/reference/slm/apis/slm-stop.asciidoc
#	docs/reference/sql/endpoints/client-apps/tableau-desktop.asciidoc
#	docs/reference/sql/endpoints/client-apps/tableau-server.asciidoc
2021-11-05 19:41:54 -04:00
James Rodewig
f9284ab0a0
[DOCS] Re-add several query params to search API docs (#79716) (#79726)
PR #55884 removed documentation for several query parameters from the search API
docs. During tests, I failed to notice that these are valid parameters but require other parameters to use.

Changes:

* Notes the following search API parameters require the `q` query string parameter:

  * `analyzer`
  * `analyze_wildcard`
  * `default_operator`
  * `df`
  * `lenient`

* Notes the following search API parameters require the `suggest_field` and `suggest_text` query parameters:

  * `suggest_mode`
  * `suggest_size`

* Re-adds the above parameters to the search API docs.

These changes also affect API documentation that reuses the search API parameters:

* Delete by query API
* Update by query API
* Count API
* Explain API
* Validate API

Closes #79674
2021-10-25 12:09:52 -04:00
Przemysław Witek
aee722dd39
[7.x] [Transform] Add _meta field to TransformConfig (#79003) (#79219) 2021-10-15 12:14:10 +02:00
edh-oss
6869f5bc0d Update JSON parser and snippets (#77983)
Related to issue  #77823

This does the following:

- Updates several asciidoc files that contained code snippets with
  invalid JSON, most involving unnecessary trailing commas.

- Makes the switch from the Groovy JSON parser to the Jackson parser,
  pursuant to the general goal of eliminating Groovy dependence.

- Makes testing of JSON validity at build time more strict.

Note that this update still allows backslash escaping for any
character. Currently that matters because of the file
"docs/reference/ml/anomaly-detection/apis/get-datafeed-stats.asciidoc",
specifically this part:

    "attributes" : {
      "ml.machine_memory" :
        "$body.datafeeds.0.node.attributes.ml\.machine_memory",
      "ml.max_open_jobs" : "512"
    }

It's not clear to me what change, if any, is appropriate there. So,
I've left in the escaped period and configured the parser to ignore
it for the time being.
2021-09-20 11:11:54 +01:00
István Zoltán Szabó
e62a7a47f1
[DOCS] Fixes description of index_total property for GET Transforms stats API docs. (#77354) (#77401) 2021-09-08 09:24:47 +02:00
James Rodewig
db837e7132
[7.x] [DOCS] Update anchor and add redirect for aliases (#77349) (#77355)
* [DOCS] Update anchor and add redirect for aliases (#77349)

PRs #73062 and #73043 repurposed the `alias` anchor for a new guide for index
and data stream aliases. Previously, this anchor was used for our field alias
documentation.

Repurposing the anchor has caused continuity errors for users selecting
different versions of the ES docs. It could also cause confusion for users with
a `/current/` link to the `alias` page.

This updates the anchor for the alias guide and adds a redirect page to
disambiguate the `alias` anchor.

It also fixes a bread crumb issue for redirects following the 'Modifying your
Data' redirect page.

Closes #77034.
# Conflicts:
#	docs/reference/search/multi-search.asciidoc

* [DOCS] Add anchor text to field alias redirect
2021-09-07 11:36:49 -04:00
Gordon Brown
f3348a8d27
Node shutdown API docs (#74505)
Adds API docs for the new Node Shutdown APIs.
2021-08-19 11:00:19 -06:00
Przemysław Witek
e8fc16e636
[Transform] Rename interim_results to align_checkpoints (#76609) (#76645) 2021-08-18 14:49:51 +02:00
Mayya Sharipova
29048de0d6
Remove xpack actions for vector field (#75302)
We have already decided not to have xpack usage for field mappers
(see #53076). As mappings stats of all fields is already tracked
in cluster stats.
Moreover xpack usage for vector field is a quite expensive operation
(see #74974).

This removes xpack actions for vector field.

Backport for #75017
2021-07-13 11:33:52 -04:00
elasticsearchmachine
2bacc4bb59
[DOCS] Document async SQL APIs (#75078) (#75251)
Adds formal API docs and JSON specs for the following APIs:

* Get async SQL search
* Get async SQL search status
* Delete async SQL search

Closes #74845

Co-authored-by: James Rodewig <40268737+jrodewig@users.noreply.github.com>
2021-07-12 11:20:14 -04:00
Hendrik Muhs
309240287e
[7.x][Transform] changing hard coded 10k page size limit to 65k (#74651) (#74925)
changes hard coded 10k page size limit to 65k(default for `search.max_bucket`)

Closes #57719
2021-07-05 17:06:12 +02:00
James Rodewig
ae5dac848d
[DOCS] Move EQL APIs to separate page (#74846) (#74859)
In preparation for #74845, we need to create formal API reference documentation for our SQL APIs.

Due to the number of SQL APIs, we'll likely need to create a separate nested page for them. For parity, this PR moves
our EQL APIs to a separate page as well. Previously, they were listed under our search APIs.
2021-07-01 15:01:53 -04:00
James Rodewig
d3a6847b36
[DOCS] Reuse aliases object properties in API docs (#73421) (#73661)
Changes:
* Reuses the same `aliases` object properties in the following API docs:
  * Clone index API
  * Create index API
  * Put component template API
  * Put legacy index template API
  * Put index template API
  * Rollover index API
  * Shrink index API
  * Simulate template API
  * Split index API
* Updates the `aliases` object properties for the simulate index API docs.

Closes #73044
2021-06-02 08:43:19 -04:00
James Rodewig
465a6a104e
[DOCS] Update alias API docs for data stream aliases (#73419) (#73591)
Updates the docs for several alias APIs for data stream aliases. Also
removes some redundant examples now covered in the [aliases guide][0].

[0]: https://www.elastic.co/guide/en/elasticsearch/reference/master/alias.html
2021-06-01 08:55:09 -04:00
James Rodewig
18423633d7 [DOCS] Change 'wildcard expression' to 'wildcard pattern' 2021-05-26 09:21:04 -04:00
James Rodewig
21ae3440b4
[DOCS] Update alias xrefs (#73380) (#73391)
Updates several internal 'alias' xrefs to point to the aliases guide rather than
API docs.
2021-05-26 08:15:35 -04:00
James Rodewig
91e35883e0
[DOCS] Expand and reuse aliases parameters (#73296) (#73321)
Changes:

* Expands the `aliases` parameter for the create index API to better document
  supported properties.

* Reuses `aliases` parameter in the following API docs:
  * Clone index API
  * Shrink index API
  * Split index API
2021-05-24 08:50:03 -04:00
James Rodewig
066682625e
[DOCS] Update hidden anchor (#73287) (#73288) 2021-05-20 14:49:19 -04:00
James Rodewig
11269618d0
[DOCS] Consolidate routing parameter definitions (#73107) (#73109)
Combines duplicate definitions for the `routing` parameter.
2021-05-14 12:37:07 -04:00
Hendrik Muhs
6175b6dbb4
[7.x][Transform] add support for top metrics (#72311)
add support for the stats and top metrics aggregation in transform. With this change it became
easier to add more multi value aggregations to transform

Limitations:
 - only the 1st element of top_metrics gets consumed by transform[*].
 - all values of stats will be mapped to double if mapping deduction is used, including count,
   sum, min, max

fixes #52236
relates #51925
2021-04-27 17:40:52 +02:00
James Rodewig
d84cac0590
[DOCS] Fix typos (#72227) (#72256)
Co-authored-by: Pierre Grimaud <grimaud.pierre@gmail.com>
2021-04-26 14:18:27 -04:00
James Rodewig
570bbc81f8 [DOCS] Fix data type of include_defaults parameter 2021-04-23 10:07:46 -04:00
James Rodewig
5172fd8058
[DOCS] Clarify timeout and terminate_after parameters (#71713) (#72163)
Co-authored-by: James Rodewig <40268737+jrodewig@users.noreply.github.com>

Co-authored-by: Wylie Conlon <william.conlon@elastic.co>
2021-04-23 09:53:57 -04:00
James Rodewig
f9daaaf436
[DOCS] Remove internal versioning for concurrency control (#71570) (#72098)
Co-authored-by: Yang Cheng <chengyang2048@163.com>
2021-04-22 15:46:27 -04:00
James Rodewig
404e0b92ca
[DOCS] Document create stored script API (#71493) (#71838) 2021-04-19 09:33:20 -04:00
Tim Brooks
08f81d58bf
Add fleet polling API for global checkpoint (#71705)
Fleet server needs an API to access up to date global checkpoints for
indices. Additionally, it requires a mode of operation when fleet can
provide its current knowledge about the global checkpoints and poll for
advancements. This commit introduces this API in the fleet plugin.
2021-04-14 12:28:17 -06:00
Lyudmila Fokina
3c7731dd3f
Warn users if security is implicitly disabled (#71650)
* Warn users if security is implicitly disabled (#70114)

Elasticsearch has security features implicitly disabled by default for
Basic and Trial licenses, unless explicitly set in the configuration
file.
This may be good for onboarding, but it also lead to unintended insecure
 clusters.
 This change introduces clear warnings when security features are
 implicitly disabled.
 - a warning header in each REST response if security is implicitly
 disabled;
 - a log message during cluster boot.
2021-04-13 20:51:52 +02:00
Nhat Nguyen
5913b79dd3
Allow specify dynamic templates in bulk request (#71518)
This change allows users to specify dynamic templates in a bulk request.

```
PUT myindex
{
  "mappings": {
    "dynamic_templates": [{
      "time_histograms": {
        "mapping": {
          "type": "histogram",
          "meta": {
            "unit": "s"
          }
        }
      }
    }]
  }
}
```

```
POST myindex/_bulk
{ "index": { "dynamic_templates": { "response_times": "time_histograms" } } }
{ "@timestamp": "2020-08-12", "response_times": { "values": [1, 10], "counts": [5, 1] }}
```

Closes #61939
2021-04-10 10:14:11 -04:00
James Rodewig
c757f9e4e7
[DOCS] Fix double spaces (#71082) (#71120) 2021-03-31 11:43:34 -04:00
James Rodewig
994811584a
[DOCS] Move enrich policy object def to API docs (#70825) (#70866) 2021-03-25 09:32:29 -04:00
James Rodewig
0086f6209e
[DOCS] Document date math support for aliases (#70535) (#70567)
Co-authored-by: James Rodewig <40268737+jrodewig@users.noreply.github.com>

Co-authored-by: Tommmster <tomasninokehoe@gmail.com>
2021-03-18 11:04:18 -04:00
Yannick Welsch
9f1b254c90
Extend searchable snapshots feature usage stats (#70441) (#70466)
Extends the feature usage stats, distinguishing between full_copy and shared_cache style searchable snapshot indices.
2021-03-17 09:39:45 +01:00
Julie Tibshirani
13946ea7e2
Move flattened field to core. (#70122)
This field mapper only lived in its own module so it could be licensed as x-pack
basic. Now it can be moved to core, which matches its status as a core type.

The PR also removes flattened fields from xpack usage stats now that they live
in core. The usage stats were already removed in on master, but this PR was not
backported to avoid a breaking change on 7.x. We have now clarified that usage
stats updates are not considered breaking, so it is safe to backport this
change.
2021-03-11 11:23:28 -08:00
István Zoltán Szabó
e406cc5f8f
[DOCS] Expands transforms docs with CCS info (#70156) (#70241)
Co-authored-by: Lisa Cawley <lcawley@elastic.co>
2021-03-11 10:57:51 +01:00
James Rodewig
e52a5ed1b9
[DOCS] Update ingest pipeline xrefs (#70178) (#70227) 2021-03-10 08:42:49 -05:00
Luca Cavanna
eb532691d7
Move runtime fields stats to server (#69487)
Runtime fields usage is currently reported as part of the xpack feature usage API. Now that runtime fields are part of server, their corresponding stats can be moved to be part of the ordinary mapping stats exposed by the cluster stats API.
2021-03-08 12:40:54 +01:00
Gordon Brown
2657496dc7
Change Get Snapshottable Features endpoint to _features (#69755)
The endpoint `_snapshottable_features` is long and implies incorrect
things about this API - it is used not just for snapshots, but also for
the upcoming reset API. Following discussions on the team, this commit
changes the endpoint to `_features` and removes the connection between
this API and snapshots, as snapshots are not the only use for the output
of this API.
2021-03-02 15:33:40 -07:00
James Rodewig
07593e5fb6
[DOCS] Remove duplicate index alias filter def (#69716) 2021-03-01 11:20:07 -05:00
Dimitris Athanasiou
273a107099
[7.x][ML] Expand usage stats for data frame analytics and trained models (#69477) (#69556)
This adds additional statistics into the usage API for data frame analytics
and trained models.

For data frame analytics the added stats are:

  - count of jobs by analysis type
  - stats for peak_usage_bytes

For trained models the added stats are:
  - counts of: total, prepackaged, other (not created by data frame analytics)
  - counts by analysis type based on the inference config
  - stats for estimated heap usage
  - stats for estimated number of operations

Backport of #69477
2021-02-24 19:53:06 +02:00