Skip to content

Commit

Permalink
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
[ML] Update api descriptions to be clearer
Browse files Browse the repository at this point in the history
[ML] Update api descriptions to be clearer
qn895 committed Aug 19, 2020
1 parent 66d8f47 commit 7c5dfde
Showing 1 changed file with 2 additions and 2 deletions.
4 changes: 2 additions & 2 deletions x-pack/plugins/ml/server/routes/results_service.ts
Original file line number Diff line number Diff line change
@@ -289,7 +289,7 @@ export function resultsServiceRoutes({ router, mlLicense }: RouteInitialization)
*
* @api {get} /api/ml/results/:jobId/categorizer_stats
* @apiName GetCategorizerStats
* @apiDescription Returns the categorizer snapshots for the specified job ID
* @apiDescription Returns the categorizer stats for the specified job ID
* @apiSchema (params) jobIdSchema
* @apiSchema (query) getCategorizerStatsSchema
*/
@@ -321,7 +321,7 @@ export function resultsServiceRoutes({ router, mlLicense }: RouteInitialization)
*
* @api {get} /api/ml/results/category_stopped_partitions
* @apiName GetCategoryStoppedPartitions
* @apiDescription Returns list of partitions we stopped categorizing whens status changed to warn
* @apiDescription Returns information on the partitions that have stopped being categorized due to the categorization status changing from ok to warn. Can return either the list of stopped partitions for each job, or just the list of job IDs.
* @apiSchema (body) getCategorizerStoppedPartitionsSchema
*/
router.post(

0 comments on commit 7c5dfde

Please sign in to comment.