[DOCS] Adds missing icons to ML HLRC APIs (#46515)
This commit is contained in:
Lisa Cawley
lcawl
parent
cdc3a260af
commit
7461259ba6
|
|
@ -3,6 +3,7 @@
|
|||
:request: CloseJobRequest
|
||||
:response: CloseJobResponse
|
||||
--
|
||||
[role="xpack"]
|
||||
[id="{upid}-{api}"]
|
||||
=== Close {anomaly-job} API
|
||||
|
||||
|
|
|
|||
|
|
@ -3,6 +3,7 @@
|
|||
:request: DeleteCalendarEventRequest
|
||||
:response: AcknowledgedResponse
|
||||
--
|
||||
[role="xpack"]
|
||||
[id="{upid}-{api}"]
|
||||
=== Delete calendar event API
|
||||
Removes a scheduled event from an existing {ml} calendar.
|
||||
|
|
|
|||
|
|
@ -3,6 +3,7 @@
|
|||
:request: DeleteCalendarJobRequest
|
||||
:response: PutCalendarResponse
|
||||
--
|
||||
[role="xpack"]
|
||||
[id="{upid}-{api}"]
|
||||
=== Delete {anomaly-jobs} from calendar API
|
||||
Removes {anomaly-jobs} from an existing {ml} calendar.
|
||||
|
|
|
|||
|
|
@ -3,6 +3,7 @@
|
|||
:request: DeleteCalendarRequest
|
||||
:response: AcknowledgedResponse
|
||||
--
|
||||
[role="xpack"]
|
||||
[id="{upid}-{api}"]
|
||||
=== Delete calendar API
|
||||
Delete a {ml} calendar.
|
||||
|
|
|
|||
|
|
@ -3,6 +3,7 @@
|
|||
:request: DeleteDataFrameAnalyticsRequest
|
||||
:response: AcknowledgedResponse
|
||||
--
|
||||
[role="xpack"]
|
||||
[id="{upid}-{api}"]
|
||||
=== Delete Data Frame Analytics API
|
||||
|
||||
|
|
|
|||
|
|
@ -3,6 +3,7 @@
|
|||
:request: DeleteDatafeedRequest
|
||||
:response: AcknowledgedResponse
|
||||
--
|
||||
[role="xpack"]
|
||||
[id="{upid}-delete-datafeed"]
|
||||
=== Delete datafeed API
|
||||
|
||||
|
|
|
|||
|
|
@ -4,6 +4,7 @@
|
|||
:request: DeleteExpiredRequest
|
||||
:response: DeleteExpiredResponse
|
||||
--
|
||||
[role="xpack"]
|
||||
[id="{upid}-{api}"]
|
||||
=== Delete Expired Data API
|
||||
Delete expired {ml} data.
|
||||
|
|
|
|||
|
|
@ -3,6 +3,7 @@
|
|||
:request: DeleteFilterRequest
|
||||
:response: AcknowledgedResponse
|
||||
--
|
||||
[role="xpack"]
|
||||
[id="{upid}-{api}"]
|
||||
=== Delete Filter API
|
||||
Delete a {ml} filter.
|
||||
|
|
|
|||
|
|
@ -3,6 +3,7 @@
|
|||
:request: DeleteForecastRequest
|
||||
:response: AcknowledgedResponse
|
||||
--
|
||||
[role="xpack"]
|
||||
[id="{upid}-{api}"]
|
||||
=== Delete Forecast API
|
||||
|
||||
|
|
|
|||
|
|
@ -3,6 +3,7 @@
|
|||
:request: DeleteJobRequest
|
||||
:response: AcknowledgedResponse
|
||||
--
|
||||
[role="xpack"]
|
||||
[id="{upid}-{api}"]
|
||||
=== Delete {anomaly-job} API
|
||||
|
||||
|
|
|
|||
|
|
@ -3,6 +3,7 @@
|
|||
:request: DeleteModelSnapshotRequest
|
||||
:response: AcknowledgedResponse
|
||||
--
|
||||
[role="xpack"]
|
||||
[id="{upid}-{api}"]
|
||||
=== Delete Model Snapshot API
|
||||
|
||||
|
|
|
|||
|
|
@ -3,6 +3,7 @@
|
|||
:request: PutDataFrameAnalyticsRequest
|
||||
:response: EstimateMemoryUsageResponse
|
||||
--
|
||||
[role="xpack"]
|
||||
[id="{upid}-{api}"]
|
||||
=== Estimate memory usage API
|
||||
|
||||
|
|
|
|||
|
|
@ -3,6 +3,7 @@
|
|||
:request: EvaluateDataFrameRequest
|
||||
:response: EvaluateDataFrameResponse
|
||||
--
|
||||
[role="xpack"]
|
||||
[id="{upid}-{api}"]
|
||||
=== Evaluate Data Frame API
|
||||
|
||||
|
|
|
|||
|
|
@ -3,6 +3,7 @@
|
|||
:request: FindFileStructureRequest
|
||||
:response: FindFileStructureResponse
|
||||
--
|
||||
[role="xpack"]
|
||||
[id="{upid}-{api}"]
|
||||
=== Find File Structure API
|
||||
|
||||
|
|
|
|||
|
|
@ -3,6 +3,7 @@
|
|||
:request: FlushJobRequest
|
||||
:response: FlushJobResponse
|
||||
--
|
||||
[role="xpack"]
|
||||
[id="{upid}-{api}"]
|
||||
=== Flush Job API
|
||||
|
||||
|
|
|
|||
|
|
@ -3,6 +3,7 @@
|
|||
:request: ForecastJobRequest
|
||||
:response: ForecastJobResponse
|
||||
--
|
||||
[role="xpack"]
|
||||
[id="{upid}-{api}"]
|
||||
=== Forecast Job API
|
||||
|
||||
|
|
|
|||
|
|
@ -3,6 +3,7 @@
|
|||
:request: GetBucketsRequest
|
||||
:response: GetBucketsResponse
|
||||
--
|
||||
[role="xpack"]
|
||||
[id="{upid}-{api}"]
|
||||
=== Get buckets API
|
||||
|
||||
|
|
|
|||
|
|
@ -3,6 +3,7 @@
|
|||
:request: GetCalendarEventsRequest
|
||||
:response: GetCalendarEventsResponse
|
||||
--
|
||||
[role="xpack"]
|
||||
[id="{upid}-{api}"]
|
||||
=== Get calendar events API
|
||||
Retrieves a calendar's events.
|
||||
|
|
|
|||
|
|
@ -3,6 +3,7 @@
|
|||
:request: GetCalendarsRequest
|
||||
:response: GetCalendarsResponse
|
||||
--
|
||||
[role="xpack"]
|
||||
[id="{upid}-{api}"]
|
||||
=== Get calendars API
|
||||
Retrieves one or more calendar objects.
|
||||
|
|
|
|||
|
|
@ -3,6 +3,7 @@
|
|||
:request: GetCategoriesRequest
|
||||
:response: GetCategoriesResponse
|
||||
--
|
||||
[role="xpack"]
|
||||
[id="{upid}-{api}"]
|
||||
=== Get categories API
|
||||
|
||||
|
|
|
|||
|
|
@ -3,6 +3,7 @@
|
|||
:request: GetDataFrameAnalyticsStatsRequest
|
||||
:response: GetDataFrameAnalyticsStatsResponse
|
||||
--
|
||||
[role="xpack"]
|
||||
[id="{upid}-{api}"]
|
||||
=== Get Data Frame Analytics Stats API
|
||||
|
||||
|
|
|
|||
|
|
@ -3,6 +3,7 @@
|
|||
:request: GetDataFrameAnalyticsRequest
|
||||
:response: GetDataFrameAnalyticsResponse
|
||||
--
|
||||
[role="xpack"]
|
||||
[id="{upid}-{api}"]
|
||||
=== Get Data Frame Analytics API
|
||||
|
||||
|
|
|
|||
|
|
@ -3,6 +3,7 @@
|
|||
:request: GetDatafeedStatsRequest
|
||||
:response: GetDatafeedStatsResponse
|
||||
--
|
||||
[role="xpack"]
|
||||
[id="{upid}-{api}"]
|
||||
=== Get datafeed stats API
|
||||
|
||||
|
|
|
|||
|
|
@ -3,6 +3,7 @@
|
|||
:request: GetDatafeedRequest
|
||||
:response: GetDatafeedResponse
|
||||
--
|
||||
[role="xpack"]
|
||||
[id="{upid}-{api}"]
|
||||
=== Get datafeed API
|
||||
|
||||
|
|
|
|||
|
|
@ -3,6 +3,7 @@
|
|||
:request: GetFiltersRequest
|
||||
:response: GetFiltersResponse
|
||||
--
|
||||
[role="xpack"]
|
||||
[id="{upid}-{api}"]
|
||||
=== Get filters API
|
||||
|
||||
|
|
|
|||
|
|
@ -3,6 +3,7 @@
|
|||
:request: GetInfluencersRequest
|
||||
:response: GetInfluencersResponse
|
||||
--
|
||||
[role="xpack"]
|
||||
[id="{upid}-{api}"]
|
||||
=== Get influencers API
|
||||
|
||||
|
|
|
|||
|
|
@ -3,6 +3,7 @@
|
|||
:request: MlInfoRequest
|
||||
:response: MlInfoResponse
|
||||
--
|
||||
[role="xpack"]
|
||||
[id="{upid}-{api}"]
|
||||
=== ML get info API
|
||||
|
||||
|
|
|
|||
|
|
@ -3,6 +3,7 @@
|
|||
:request: GetJobStatsRequest
|
||||
:response: GetJobStatsResponse
|
||||
--
|
||||
[role="xpack"]
|
||||
[id="{upid}-{api}"]
|
||||
=== Get {anomaly-job} stats API
|
||||
|
||||
|
|
|
|||
|
|
@ -3,6 +3,7 @@
|
|||
:request: GetJobRequest
|
||||
:response: GetJobResponse
|
||||
--
|
||||
[role="xpack"]
|
||||
[id="{upid}-{api}"]
|
||||
=== Get {anomaly-jobs} API
|
||||
|
||||
|
|
|
|||
|
|
@ -3,6 +3,7 @@
|
|||
:request: GetModelSnapshotsRequest
|
||||
:response: GetModelSnapshotsResponse
|
||||
--
|
||||
[role="xpack"]
|
||||
[id="{upid}-{api}"]
|
||||
=== Get model snapshots API
|
||||
|
||||
|
|
|
|||
|
|
@ -3,6 +3,7 @@
|
|||
:request: GetOverallBucketsRequest
|
||||
:response: GetOverallBucketsResponse
|
||||
--
|
||||
[role="xpack"]
|
||||
[id="{upid}-{api}"]
|
||||
=== Get overall buckets API
|
||||
|
||||
|
|
|
|||
|
|
@ -3,6 +3,7 @@
|
|||
:request: GetRecordsRequest
|
||||
:response: GetRecordsResponse
|
||||
--
|
||||
[role="xpack"]
|
||||
[id="{upid}-{api}"]
|
||||
=== Get records API
|
||||
|
||||
|
|
|
|||
|
|
@ -3,6 +3,7 @@
|
|||
:request: OpenJobRequest
|
||||
:response: OpenJobResponse
|
||||
--
|
||||
[role="xpack"]
|
||||
[id="{upid}-{api}"]
|
||||
=== Open {anomaly-job} API
|
||||
|
||||
|
|
|
|||
|
|
@ -3,6 +3,7 @@
|
|||
:request: PostCalendarEventRequest
|
||||
:response: PostCalendarEventResponse
|
||||
--
|
||||
[role="xpack"]
|
||||
[id="{upid}-{api}"]
|
||||
=== Post Calendar Event API
|
||||
Adds new ScheduledEvents to an existing {ml} calendar.
|
||||
|
|
|
|||
|
|
@ -3,6 +3,7 @@
|
|||
:request: PostDataRequest
|
||||
:response: PostDataResponse
|
||||
--
|
||||
[role="xpack"]
|
||||
[id="{upid}-{api}"]
|
||||
=== Post Data API
|
||||
|
||||
|
|
|
|||
|
|
@ -3,6 +3,7 @@
|
|||
:request: PreviewDatafeedRequest
|
||||
:response: PreviewDatafeedResponse
|
||||
--
|
||||
[role="xpack"]
|
||||
[id="{upid}-{api}"]
|
||||
=== Preview Datafeed API
|
||||
|
||||
|
|
|
|||
|
|
@ -3,6 +3,7 @@
|
|||
:request: PutCalendarJobRequest
|
||||
:response: PutCalendarResponse
|
||||
--
|
||||
[role="xpack"]
|
||||
[id="{upid}-{api}"]
|
||||
=== Put {anomaly-jobs} in calendar API
|
||||
Adds {anomaly-jobs} jobs to an existing {ml} calendar.
|
||||
|
|
|
|||
|
|
@ -3,6 +3,7 @@
|
|||
:request: PutCalendarRequest
|
||||
:response: PutCalendarResponse
|
||||
--
|
||||
[role="xpack"]
|
||||
[id="{upid}-{api}"]
|
||||
=== Put calendar API
|
||||
Creates a new {ml} calendar.
|
||||
|
|
|
|||
|
|
@ -3,6 +3,7 @@
|
|||
:request: PutDataFrameAnalyticsRequest
|
||||
:response: PutDataFrameAnalyticsResponse
|
||||
--
|
||||
[role="xpack"]
|
||||
[id="{upid}-{api}"]
|
||||
=== Put Data Frame Analytics API
|
||||
|
||||
|
|
|
|||
|
|
@ -3,6 +3,7 @@
|
|||
:request: PutDatafeedRequest
|
||||
:response: PutDatafeedResponse
|
||||
--
|
||||
[role="xpack"]
|
||||
[id="{upid}-{api}"]
|
||||
=== Put datafeed API
|
||||
|
||||
|
|
|
|||
|
|
@ -3,6 +3,7 @@
|
|||
:request: PutFilterRequest
|
||||
:response: PutFilterResponse
|
||||
--
|
||||
[role="xpack"]
|
||||
[id="{upid}-{api}"]
|
||||
=== Put Filter API
|
||||
|
||||
|
|
|
|||
|
|
@ -3,6 +3,7 @@
|
|||
:request: PutJobRequest
|
||||
:response: PutJobResponse
|
||||
--
|
||||
[role="xpack"]
|
||||
[id="{upid}-{api}"]
|
||||
=== Put {anomaly-job} API
|
||||
|
||||
|
|
|
|||
|
|
@ -3,6 +3,8 @@
|
|||
:request: RevertModelSnapshotRequest
|
||||
:response: RevertModelSnapshotResponse
|
||||
--
|
||||
[role="xpack"]
|
||||
|
||||
[id="{upid}-{api}"]
|
||||
=== Revert Model Snapshot API
|
||||
|
||||
|
|
|
|||
|
|
@ -3,6 +3,7 @@
|
|||
:request: SetUpgradeModeRequest
|
||||
:response: AcknowledgedResponse
|
||||
--
|
||||
[role="xpack"]
|
||||
[id="{upid}-{api}"]
|
||||
=== Set Upgrade Mode API
|
||||
|
||||
|
|
|
|||
|
|
@ -3,6 +3,7 @@
|
|||
:request: StartDataFrameAnalyticsRequest
|
||||
:response: AcknowledgedResponse
|
||||
--
|
||||
[role="xpack"]
|
||||
[id="{upid}-{api}"]
|
||||
=== Start Data Frame Analytics API
|
||||
|
||||
|
|
|
|||
|
|
@ -3,6 +3,7 @@
|
|||
:request: StartDatafeedRequest
|
||||
:response: StartDatafeedResponse
|
||||
--
|
||||
[role="xpack"]
|
||||
[id="{upid}-{api}"]
|
||||
=== Start datafeed API
|
||||
|
||||
|
|
|
|||
|
|
@ -3,6 +3,7 @@
|
|||
:request: StopDataFrameAnalyticsRequest
|
||||
:response: StopDataFrameAnalyticsResponse
|
||||
--
|
||||
[role="xpack"]
|
||||
[id="{upid}-{api}"]
|
||||
=== Stop Data Frame Analytics API
|
||||
|
||||
|
|
|
|||
|
|
@ -3,6 +3,7 @@
|
|||
:request: StopDatafeedRequest
|
||||
:response: StopDatafeedResponse
|
||||
--
|
||||
[role="xpack"]
|
||||
[id="{upid}-{api}"]
|
||||
=== Stop Datafeed API
|
||||
|
||||
|
|
|
|||
|
|
@ -3,6 +3,7 @@
|
|||
:request: UpdateDatafeedRequest
|
||||
:response: PutDatafeedResponse
|
||||
--
|
||||
[role="xpack"]
|
||||
[id="{upid}-{api}"]
|
||||
=== Update datafeed API
|
||||
|
||||
|
|
|
|||
|
|
@ -3,6 +3,7 @@
|
|||
:request: UpdateFilterRequest
|
||||
:response: PutFilterResponse
|
||||
--
|
||||
[role="xpack"]
|
||||
[id="{upid}-{api}"]
|
||||
=== Update filter API
|
||||
|
||||
|
|
|
|||
|
|
@ -3,6 +3,7 @@
|
|||
:request: UpdateJobRequest
|
||||
:response: PutJobResponse
|
||||
--
|
||||
[role="xpack"]
|
||||
[id="{upid}-{api}"]
|
||||
=== Update {anomaly-job} API
|
||||
|
||||
|
|
|
|||
|
|
@ -3,6 +3,7 @@
|
|||
:request: UpdateModelSnapshotRequest
|
||||
:response: UpdateModelSnapshotResponse
|
||||
--
|
||||
[role="xpack"]
|
||||
[id="{upid}-{api}"]
|
||||
=== Update model snapshot API
|
||||
|
||||
|
|
|
|||
Loading…
Reference in New Issue