Skip to content

[DOCS] Removes unnecessary resource definition pages #44289

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

Merged
merged 3 commits into from
Jul 15, 2019
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
15 changes: 0 additions & 15 deletions docs/reference/ml/apis/calendarresource.asciidoc

This file was deleted.

27 changes: 23 additions & 4 deletions docs/reference/ml/apis/get-calendar-event.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,9 @@ Retrieves information about the scheduled events in calendars.
You can get scheduled event information for a single calendar or for all
calendars by using `_all`.

For more information, see
{stack-ov}/ml-calendars.html[Calendars and scheduled events].

[[ml-get-calendar-event-path-parms]]
==== {api-path-parms-title}

Expand Down Expand Up @@ -56,8 +59,26 @@ calendars by using `_all`.
The API returns the following information:

`events`::
(array) An array of scheduled event resources.
For more information, see <<ml-event-resource>>.
(array) An array of scheduled event resources. An events resource has the
following properties:

`calendar_id`:::
(string) An identifier for the calendar that contains the scheduled
event.

`description`:::
(string) A description of the scheduled event.

`end_time`:::
(date) The timestamp for the end of the scheduled event
in milliseconds since the epoch or ISO 8601 format.

`event_id`:::
(string) An automatically-generated identifier for the scheduled event.

`start_time`:::
(date) The timestamp for the beginning of the scheduled event
in milliseconds since the epoch or ISO 8601 format.

[[ml-get-calendar-event-example]]
==== {api-examples-title}
Expand Down Expand Up @@ -106,5 +127,3 @@ The API returns the following results:
// TESTRESPONSE[s/LS8LJGEBMTCMA-qz49st/$body.$_path/]
// TESTRESPONSE[s/Li8LJGEBMTCMA-qz49st/$body.$_path/]
// TESTRESPONSE[s/Ly8LJGEBMTCMA-qz49st/$body.$_path/]

For more information about these properties, see <<ml-event-resource>>.
12 changes: 10 additions & 2 deletions docs/reference/ml/apis/get-calendar.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,9 @@ Retrieves configuration information for calendars.
You can get information for a single calendar or for all calendars by using
`_all`.

For more information, see
{stack-ov}/ml-calendars.html[Calendars and scheduled events].

[[ml-get-calendar-path-parms]]
==== {api-path-parms-title}

Expand All @@ -50,8 +53,13 @@ You can get information for a single calendar or for all calendars by using
The API returns the following information:

`calendars`::
(array) An array of calendar resources.
For more information, see <<ml-calendar-resource>>.
(array) An array of calendar resources. A calendar resource has the following
properties:
`calendar_id`:::
(string) A numerical character string that uniquely identifies the calendar.

`job_ids`:::
(array) An array of job identifiers. For example: `["total-requests"]`.

[[ml-get-calendar-example]]
==== {api-examples-title}
Expand Down
12 changes: 10 additions & 2 deletions docs/reference/ml/apis/get-filter.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -49,8 +49,16 @@ You can get a single filter or all filters. For more information, see
The API returns the following information:

`filters`::
(array) An array of filter resources.
For more information, see <<ml-filter-resource>>.
(array) An array of filter resources. A filter resource has the following
properties:
`filter_id`:::
(string) A string that uniquely identifies the filter.

`description`:::
(string) A description of the filter.

`items`:::
(array of strings) An array of strings which is the filter item list.

[[ml-get-filter-example]]
==== {api-examples-title}
Expand Down
2 changes: 1 addition & 1 deletion docs/reference/ml/apis/jobresource.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -438,7 +438,7 @@ A custom rule has the following properties:
To add a scope for a field, add the field name as a key in the scope object and
set its value to an object with the following properties:
`filter_id`:::
(string) The id of the <<ml-filter-resource,filter>> to be used.
(string) The id of the filter to be used.

`filter_type`:::
(string) Either `include` (the rule applies for values in the filter)
Expand Down
20 changes: 16 additions & 4 deletions docs/reference/ml/apis/post-calendar-event.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,22 @@ of which must have a start time, end time, and description.
`events`::
(Required, array) A list of one of more scheduled events. The event's start
and end times may be specified as integer milliseconds since the epoch or as a
string in ISO 8601 format. See <<ml-event-resource>>.
string in ISO 8601 format. An event resource has the following properties:

`calendar_id`:::
(Optional, string) An identifier for the calendar that contains the scheduled
event.

`description`:::
(Optional, string) A description of the scheduled event.

`end_time`:::
(Required, date) The timestamp for the end of the scheduled event
in milliseconds since the epoch or ISO 8601 format.

`start_time`:::
(Required, date) The timestamp for the beginning of the scheduled event
in milliseconds since the epoch or ISO 8601 format.

[[ml-post-calendar-event-example]]
==== {api-examples-title}
Expand Down Expand Up @@ -87,6 +102,3 @@ The API returns the following results:
}
----
// TESTRESPONSE

For more information about these properties, see
<<ml-event-resource,Scheduled Event Resources>>.
2 changes: 1 addition & 1 deletion docs/reference/ml/apis/put-calendar.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ Instantiates a calendar.
==== {api-description-title}

For more information, see
{stack-ov}/ml-calendars.html[Calendars and Scheduled Events].
{stack-ov}/ml-calendars.html[Calendars and scheduled events].

[[ml-put-calendar-path-parms]]
==== {api-path-parms-title}
Expand Down
2 changes: 1 addition & 1 deletion docs/reference/ml/apis/update-filter.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ Updates the description of a filter, adds items, or removes items.
(Optional, array of strings) The items to add to the filter.

`description`::
(Optional, string) A description for the filter. See <<ml-filter-resource>>.
(Optional, string) A description for the filter.

`remove_items`::
(Optional, array of strings) The items to remove from the filter.
Expand Down
21 changes: 20 additions & 1 deletion docs/reference/redirects.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -620,4 +620,23 @@ without any configuration, if the total number of hits is not tracked.
[role="exclude",id="xpack-api"]
=== X-Pack APIs

{es} {xpack} APIs are now documented in <<rest-apis, REST APIs>>.
{es} {xpack} APIs are now documented in <<rest-apis, REST APIs>>.

[role="exclude",id="ml-calendar-resource"]]
=== Calendar resources

See <<ml-get-calendar>> and
{stack-ov}/ml-calendars.html[Calendars and scheduled events].

[role="exclude",id="ml-filter-resource"]
=== Filter resources

See <<ml-get-filter>> and
{stack-ov}/ml-rules.html[Machine learning custom rules].

[role="exclude",id="ml-event-resource"]
=== Scheduled event resources

See <<ml-get-calendar-event>> and
{stack-ov}/ml-calendars.html[Calendars and scheduled events].

6 changes: 0 additions & 6 deletions docs/reference/rest-api/defs.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -5,29 +5,23 @@
These resource definitions are used in APIs related to {ml-features} and
{security-features} and in {kib} advanced {ml} job configuration options.

* <<ml-calendar-resource,Calendars>>
* <<ml-datafeed-resource,{dfeeds-cap}>>
* <<ml-datafeed-counts,{dfeed-cap} counts>>
* <<ml-dfanalytics-resources,{dfanalytics-cap}>>
* <<data-frame-transform-resource,{dataframe-transforms-cap}>>
* <<ml-evaluate-dfanalytics-resources,Evaluate {dfanalytics}>>
* <<ml-filter-resource,Filters>>
* <<ml-job-resource,Jobs>>
* <<ml-jobstats,Job statistics>>
* <<ml-snapshot-resource,Model snapshots>>
* <<ml-results-resource,Results>>
* <<role-mapping-resources,Role mappings>>
* <<ml-event-resource,Scheduled Events>>

include::{es-repo-dir}/ml/apis/calendarresource.asciidoc[]
include::{es-repo-dir}/ml/apis/datafeedresource.asciidoc[]
include::{es-repo-dir}/ml/apis/dfanalyticsresources.asciidoc[]
include::{es-repo-dir}/data-frames/apis/transformresource.asciidoc[]
include::{es-repo-dir}/ml/apis/evaluateresources.asciidoc[]
include::{es-repo-dir}/ml/apis/filterresource.asciidoc[]
include::{es-repo-dir}/ml/apis/jobresource.asciidoc[]
include::{es-repo-dir}/ml/apis/jobcounts.asciidoc[]
include::{es-repo-dir}/ml/apis/snapshotresource.asciidoc[]
include::{xes-repo-dir}/rest-api/security/role-mapping-resources.asciidoc[]
include::{es-repo-dir}/ml/apis/resultsresource.asciidoc[]
include::{es-repo-dir}/ml/apis/eventresource.asciidoc[]