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

[7.8][DOCS] Replaces docdir attributes in ML APIs (#57390) #57468

Merged
merged 1 commit into from
Jun 1, 2020
+454 −454
Merged

[7.8][DOCS] Replaces docdir attributes in ML APIs (#57390) #57468

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
4 changes: 2 additions & 2 deletions docs/Versions.asciidoc
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@

include::{asciidoc-dir}/../../shared/versions/stack/{source_branch}.asciidoc[]
include::{docs-root}/shared/versions/stack/{source_branch}.asciidoc[]

:lucene_version: 8.5.1
:lucene_version_path: 8_5_1
Expand Down Expand Up @@ -72,4 +72,4 @@ endif::[]
Shared attribute values are pulled from elastic/docs
///////

include::{asciidoc-dir}/../../shared/attributes.asciidoc[]
include::{docs-root}/shared/attributes.asciidoc[]
8 changes: 4 additions & 4 deletions docs/reference/api-conventions.asciidoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,17 +22,17 @@ ability to "exclude" (`-`), for example: `test*,-test3`.

All multi index APIs support the following url query string parameters:

include::{docdir}/rest-api/common-parms.asciidoc[tag=index-ignore-unavailable]
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=index-ignore-unavailable]

include::{docdir}/rest-api/common-parms.asciidoc[tag=allow-no-indices]
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=allow-no-indices]

include::{docdir}/rest-api/common-parms.asciidoc[tag=expand-wildcards]
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=expand-wildcards]

The defaults settings for the above parameters depend on the API being used.

Some multi index APIs also support the following url query string parameter:

include::{docdir}/rest-api/common-parms.asciidoc[tag=ignore_throttled]
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=ignore_throttled]

NOTE: Single index APIs such as the <<docs>> and the
<<indices-aliases,single-index `alias` APIs>> do not support multiple indices.
Expand Down
8 changes: 4 additions & 4 deletions docs/reference/index.asciidoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,10 @@
= Elasticsearch Reference

:include-xpack: true
:es-test-dir: {docdir}/../src/test
:plugins-examples-dir: {docdir}/../../plugins/examples
:xes-repo-dir: {docdir}/../../x-pack/docs/{lang}
:es-repo-dir: {docdir}
:es-test-dir: {elasticsearch-root}/docs/src/test
:plugins-examples-dir: {elasticsearch-root}/plugins/examples
:xes-repo-dir: {elasticsearch-root}/x-pack/docs/{lang}
:es-repo-dir: {elasticsearch-root}/docs/reference


include::../Versions.asciidoc[]
Expand Down
4 changes: 2 additions & 2 deletions docs/reference/ml/anomaly-detection/apis/close-job.asciidoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -61,14 +61,14 @@ results the job might have recently produced or might produce in the future.

`<job_id>`::
(Required, string)
include::{docdir}/ml/ml-shared.asciidoc[tag=job-id-anomaly-detection-wildcard]
include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=job-id-anomaly-detection-wildcard]

[[ml-close-job-query-parms]]
==== {api-query-parms-title}

`allow_no_jobs`::
(Optional, boolean)
include::{docdir}/ml/ml-shared.asciidoc[tag=allow-no-jobs]
include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=allow-no-jobs]

`force`::
(Optional, boolean) Use to close a failed job, or to forcefully close a job
Expand Down
2 changes: 1 addition & 1 deletion docs/reference/ml/anomaly-detection/apis/delete-calendar-event.asciidoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ events and delete the calendar, see the

`<calendar_id>`::
(Required, string)
include::{docdir}/ml/ml-shared.asciidoc[tag=calendar-id]
include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=calendar-id]

`<event_id>`::
(Required, string) Identifier for the scheduled event. You can obtain this
Expand Down
4 changes: 2 additions & 2 deletions docs/reference/ml/anomaly-detection/apis/delete-calendar-job.asciidoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,11 +25,11 @@ Deletes {anomaly-jobs} from a calendar.

`<calendar_id>`::
(Required, string)
include::{docdir}/ml/ml-shared.asciidoc[tag=calendar-id]
include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=calendar-id]

`<job_id>`::
(Required, string)
include::{docdir}/ml/ml-shared.asciidoc[tag=job-id-anomaly-detection-list]
include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=job-id-anomaly-detection-list]

[[ml-delete-calendar-job-example]]
==== {api-examples-title}
Expand Down
2 changes: 1 addition & 1 deletion docs/reference/ml/anomaly-detection/apis/delete-calendar.asciidoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ calendar.

`<calendar_id>`::
(Required, string)
include::{docdir}/ml/ml-shared.asciidoc[tag=calendar-id]
include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=calendar-id]

[[ml-delete-calendar-example]]
==== {api-examples-title}
Expand Down
2 changes: 1 addition & 1 deletion docs/reference/ml/anomaly-detection/apis/delete-datafeed.asciidoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ can delete it.

`<feed_id>`::
(Required, string)
include::{docdir}/ml/ml-shared.asciidoc[tag=datafeed-id]
include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=datafeed-id]

[[ml-delete-datafeed-query-parms]]
==== {api-query-parms-title}
Expand Down
2 changes: 1 addition & 1 deletion docs/reference/ml/anomaly-detection/apis/delete-filter.asciidoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ update or delete the job before you can delete the filter.

`<filter_id>`::
(Required, string)
include::{docdir}/ml/ml-shared.asciidoc[tag=filter-id]
include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=filter-id]

[[ml-delete-filter-example]]
==== {api-examples-title}
Expand Down
2 changes: 1 addition & 1 deletion docs/reference/ml/anomaly-detection/apis/delete-forecast.asciidoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@ forecasts from the job.

`<job_id>`::
(Required, string)
include::{docdir}/ml/ml-shared.asciidoc[tag=job-id-anomaly-detection]
include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=job-id-anomaly-detection]

[[ml-delete-forecast-query-parms]]
==== {api-query-parms-title}
Expand Down
2 changes: 1 addition & 1 deletion docs/reference/ml/anomaly-detection/apis/delete-job.asciidoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ separated list.

`<job_id>`::
(Required, string)
include::{docdir}/ml/ml-shared.asciidoc[tag=job-id-anomaly-detection]
include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=job-id-anomaly-detection]

[[ml-delete-job-query-parms]]
==== {api-query-parms-title}
Expand Down
4 changes: 2 additions & 2 deletions docs/reference/ml/anomaly-detection/apis/delete-snapshot.asciidoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,11 +31,11 @@ the `model_snapshot_id` in the results from the get jobs API.

`<job_id>`::
(Required, string)
include::{docdir}/ml/ml-shared.asciidoc[tag=job-id-anomaly-detection]
include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=job-id-anomaly-detection]

`<snapshot_id>`::
(Required, string)
include::{docdir}/ml/ml-shared.asciidoc[tag=snapshot-id]
include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=snapshot-id]

[[ml-delete-snapshot-example]]
==== {api-examples-title}
Expand Down
2 changes: 1 addition & 1 deletion docs/reference/ml/anomaly-detection/apis/flush-job.asciidoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ opened again before analyzing further data.

`<job_id>`::
(Required, string)
include::{docdir}/ml/ml-shared.asciidoc[tag=job-id-anomaly-detection]
include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=job-id-anomaly-detection]

[[ml-flush-job-query-parms]]
==== {api-query-parms-title}
Expand Down
2 changes: 1 addition & 1 deletion docs/reference/ml/anomaly-detection/apis/forecast.asciidoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@ forecast. For more information about this property, see <<ml-put-job>>.

`<job_id>`::
(Required, string)
include::{docdir}/ml/ml-shared.asciidoc[tag=job-id-anomaly-detection]
include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=job-id-anomaly-detection]

[[ml-forecast-request-body]]
==== {api-request-body-title}
Expand Down
14 changes: 7 additions & 7 deletions docs/reference/ml/anomaly-detection/apis/get-bucket.asciidoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ bucket.

`<job_id>`::
(Required, string)
include::{docdir}/ml/ml-shared.asciidoc[tag=job-id-anomaly-detection]
include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=job-id-anomaly-detection]

`<timestamp>`::
(Optional, string) The timestamp of a single bucket result. If you do not
Expand All @@ -59,7 +59,7 @@ include::{docdir}/ml/ml-shared.asciidoc[tag=desc-results]

`exclude_interim`::
(Optional, boolean)
include::{docdir}/ml/ml-shared.asciidoc[tag=exclude-interim-results]
include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=exclude-interim-results]

`expand`::
(Optional, boolean) If true, the output includes anomaly records.
Expand Down Expand Up @@ -115,11 +115,11 @@ initial value that was calculated at the time the bucket was processed.

`is_interim`:::
(boolean)
include::{docdir}/ml/ml-shared.asciidoc[tag=is-interim]
include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=is-interim]

`job_id`:::
(string)
include::{docdir}/ml/ml-shared.asciidoc[tag=job-id-anomaly-detection]
include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=job-id-anomaly-detection]

`probability`:::
(number) The probability that the bucket has this behavior, in the range 0 to 1.
Expand All @@ -139,7 +139,7 @@ this.

`bucket_span`::
(number)
include::{docdir}/ml/ml-shared.asciidoc[tag=bucket-span-results]
include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=bucket-span-results]

`event_count`::
(number) The number of input data records processed in this bucket.
Expand All @@ -150,11 +150,11 @@ the initial value that was calculated at the time the bucket was processed.

`is_interim`::
(boolean)
include::{docdir}/ml/ml-shared.asciidoc[tag=is-interim]
include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=is-interim]

`job_id`::
(string)
include::{docdir}/ml/ml-shared.asciidoc[tag=job-id-anomaly-detection]
include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=job-id-anomaly-detection]

`processing_time_ms`::
(number) The amount of time, in milliseconds, that it took to analyze the bucket
Expand Down
4 changes: 2 additions & 2 deletions docs/reference/ml/anomaly-detection/apis/get-calendar-event.asciidoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ For more information, see

`<calendar_id>`::
(Required, string)
include::{docdir}/ml/ml-shared.asciidoc[tag=calendar-id]
include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=calendar-id]

[[ml-get-calendar-event-request-body]]
==== {api-request-body-title}
Expand All @@ -62,7 +62,7 @@ following properties:

`calendar_id`::
(string)
include::{docdir}/ml/ml-shared.asciidoc[tag=calendar-id]
include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=calendar-id]

`description`::
(string) A description of the scheduled event.
Expand Down
4 changes: 2 additions & 2 deletions docs/reference/ml/anomaly-detection/apis/get-calendar.asciidoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ For more information, see

`<calendar_id>`::
(Required, string)
include::{docdir}/ml/ml-shared.asciidoc[tag=calendar-id]
include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=calendar-id]

[[ml-get-calendar-request-body]]
==== {api-request-body-title}
Expand All @@ -55,7 +55,7 @@ properties:

`calendar_id`::
(string)
include::{docdir}/ml/ml-shared.asciidoc[tag=calendar-id]
include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=calendar-id]

`job_ids`::
(array) An array of {anomaly-job} identifiers. For example: `["total-requests"]`.
Expand Down
4 changes: 2 additions & 2 deletions docs/reference/ml/anomaly-detection/apis/get-category.asciidoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,7 @@ parameter, the API returns information about all categories in the {anomaly-job}

`<job_id>`::
(Required, string)
include::{docdir}/ml/ml-shared.asciidoc[tag=job-id-anomaly-detection]
include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=job-id-anomaly-detection]

[[ml-get-category-request-body]]
==== {api-request-body-title}
Expand Down Expand Up @@ -80,7 +80,7 @@ manual tweaking.

`job_id`::
(string)
include::{docdir}/ml/ml-shared.asciidoc[tag=job-id-anomaly-detection]
include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=job-id-anomaly-detection]

`max_matching_length`::
(unsigned integer) The maximum length of the fields that matched the category.
Expand Down
32 changes: 16 additions & 16 deletions docs/reference/ml/anomaly-detection/apis/get-datafeed-stats.asciidoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,7 @@ IMPORTANT: This API returns a maximum of 10,000 {dfeeds}.

`<feed_id>`::
(Optional, string)
include::{docdir}/ml/ml-shared.asciidoc[tag=datafeed-id-wildcard]
include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=datafeed-id-wildcard]
+
--
If you do not specify one of these options, the API returns information about
Expand All @@ -58,7 +58,7 @@ all {dfeeds}.

`allow_no_datafeeds`::
(Optional, boolean)
include::{docdir}/ml/ml-shared.asciidoc[tag=allow-no-datafeeds]
include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=allow-no-datafeeds]

[role="child_attributes"]
[[ml-get-datafeed-stats-results]]
Expand All @@ -69,45 +69,45 @@ informational; you cannot update their values.

`assignment_explanation`::
(string)
include::{docdir}/ml/ml-shared.asciidoc[tag=assignment-explanation-datafeeds]
include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=assignment-explanation-datafeeds]

`datafeed_id`::
(string)
include::{docdir}/ml/ml-shared.asciidoc[tag=datafeed-id]
include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=datafeed-id]

`node`::
(object)
include::{docdir}/ml/ml-shared.asciidoc[tag=node-datafeeds]
include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=node-datafeeds]
+
--
[%collapsible%open]
====
`attributes`:::
(object)
include::{docdir}/ml/ml-shared.asciidoc[tag=node-attributes]
include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=node-attributes]

`ephemeral_id`:::
(string)
include::{docdir}/ml/ml-shared.asciidoc[tag=node-ephemeral-id]
include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=node-ephemeral-id]

`id`:::
(string)
include::{docdir}/ml/ml-shared.asciidoc[tag=node-id]
include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=node-id]

`name`:::
(string)
The node name. For example, `0-o0tOo`.

`transport_address`:::
(string)
include::{docdir}/ml/ml-shared.asciidoc[tag=node-transport-address]
include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=node-transport-address]

====
--

`state`::
(string)
include::{docdir}/ml/ml-shared.asciidoc[tag=state-datafeed]
include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=state-datafeed]

`timing_stats`::
(object) An object that provides statistical information about timing aspect of
Expand All @@ -118,24 +118,24 @@ this {dfeed}.
====
`average_search_time_per_bucket_ms`:::
(double)
include::{docdir}/ml/ml-shared.asciidoc[tag=search-bucket-avg]
include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=search-bucket-avg]

`bucket_count`:::
(long)
include::{docdir}/ml/ml-shared.asciidoc[tag=bucket-count]
include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=bucket-count]

`exponential_average_search_time_per_hour_ms`:::
(double)
include::{docdir}/ml/ml-shared.asciidoc[tag=search-exp-avg-hour]
include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=search-exp-avg-hour]

`job_id`:::
include::{docdir}/ml/ml-shared.asciidoc[tag=job-id-anomaly-detection]
include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=job-id-anomaly-detection]

`search_count`:::
include::{docdir}/ml/ml-shared.asciidoc[tag=search-count]
include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=search-count]

`total_search_time_ms`:::
include::{docdir}/ml/ml-shared.asciidoc[tag=search-time]
include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=search-time]
====
--

Expand Down
4 changes: 2 additions & 2 deletions docs/reference/ml/anomaly-detection/apis/get-datafeed.asciidoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@ IMPORTANT: This API returns a maximum of 10,000 {dfeeds}.

`<feed_id>`::
(Optional, string)
include::{docdir}/ml/ml-shared.asciidoc[tag=datafeed-id-wildcard]
include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=datafeed-id-wildcard]
+
--
If you do not specify one of these options, the API returns information about
Expand All @@ -55,7 +55,7 @@ all {dfeeds}.

`allow_no_datafeeds`::
(Optional, boolean)
include::{docdir}/ml/ml-shared.asciidoc[tag=allow-no-datafeeds]
include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=allow-no-datafeeds]

[[ml-get-datafeed-results]]
==== {api-response-body-title}
Expand Down
Loading