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

[ML] Update apidoc config with the Trained models endpoints #83274

Merged
merged 3 commits into from
Nov 12, 2020
Merged

[ML] Update apidoc config with the Trained models endpoints #83274

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
9f345b3
[ML] fix apidoc annotations
darnautov Nov 12, 2020
7747b29
[ML] add trained models
darnautov Nov 12, 2020
6b2e63b
[ML] use full path to the apidoc-markdown package
darnautov Nov 12, 2020
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
2 changes: 1 addition & 1 deletion x-pack/plugins/ml/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,6 @@
"license": "Elastic-License",
"scripts": {
"build:apiDocScripts": "cd server/routes/apidoc_scripts && ../../../../../../node_modules/.bin/tsc",
"apiDocs": "yarn build:apiDocScripts && cd ./server/routes/ && ../../../../../node_modules/.bin/apidoc --parse-workers apischema=./apidoc_scripts/target/schema_worker.js --parse-parsers apischema=./apidoc_scripts/target/schema_parser.js --parse-filters apiversion=./apidoc_scripts/target/version_filter.js -i . -o ../routes_doc && apidoc-markdown -p ../routes_doc -o ../routes_doc/ML_API.md -t ./apidoc_scripts/template.md"
"apiDocs": "yarn build:apiDocScripts && cd ./server/routes/ && ../../../../../node_modules/.bin/apidoc --parse-workers apischema=./apidoc_scripts/target/schema_worker.js --parse-parsers apischema=./apidoc_scripts/target/schema_parser.js --parse-filters apiversion=./apidoc_scripts/target/version_filter.js -i . -o ../routes_doc && ../../../../../node_modules/.bin/apidoc-markdown -p ../routes_doc -o ../routes_doc/ML_API.md -t ./apidoc_scripts/template.md"
}
}
8 changes: 7 additions & 1 deletion x-pack/plugins/ml/server/routes/apidoc.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -148,6 +148,12 @@
"InitializeJobSavedObjects",
"AssignJobsToSpaces",
"RemoveJobsFromSpaces",
"JobsSpaces"
"JobsSpaces",

"TrainedModels",
"GetTrainedModel",
"GetTrainedModelStats",
"GetTrainedModelPipelines",
"DeleteTrainedModel"
]
}
30 changes: 15 additions & 15 deletions x-pack/plugins/ml/server/routes/trained_models.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,11 +16,11 @@ import { InferenceConfigResponse } from '../../common/types/trained_models';

export function trainedModelsRoutes({ router, routeGuard }: RouteInitialization) {
/**
* @apiGroup Inference
* @apiGroup TrainedModels
*
* @api {get} /api/ml/trained_models/:modelId Get info of a trained inference model
* @apiName GetInferenceModel
* @apiDescription Retrieves configuration information for a trained inference model.
* @apiName GetTrainedModel
* @apiDescription Retrieves configuration information for a trained model.
*/
router.get(
{
Expand Down Expand Up @@ -68,11 +68,11 @@ export function trainedModelsRoutes({ router, routeGuard }: RouteInitialization)
);

/**
* @apiGroup Inference
* @apiGroup TrainedModels
*
* @api {get} /api/ml/trained_models/:modelId/_stats Get stats of a trained inference model
* @apiName GetInferenceModelStats
* @apiDescription Retrieves usage information for trained inference models.
* @api {get} /api/ml/trained_models/:modelId/_stats Get stats of a trained model
* @apiName GetTrainedModelStats
* @apiDescription Retrieves usage information for trained models.
*/
router.get(
{
Expand Down Expand Up @@ -100,11 +100,11 @@ export function trainedModelsRoutes({ router, routeGuard }: RouteInitialization)
);

/**
* @apiGroup Inference
* @apiGroup TrainedModels
*
* @api {get} /api/ml/trained_models/:modelId/pipelines Get model pipelines
* @apiName GetModelPipelines
* @apiDescription Retrieves pipelines associated with a model
* @api {get} /api/ml/trained_models/:modelId/pipelines Get trained model pipelines
* @apiName GetTrainedModelPipelines
* @apiDescription Retrieves pipelines associated with a trained model
*/
router.get(
{
Expand All @@ -130,11 +130,11 @@ export function trainedModelsRoutes({ router, routeGuard }: RouteInitialization)
);

/**
* @apiGroup Inference
* @apiGroup TrainedModels
*
* @api {delete} /api/ml/trained_models/:modelId Get stats of a trained inference model
* @apiName DeleteInferenceModel
* @apiDescription Deletes an existing trained inference model that is currently not referenced by an ingest pipeline.
* @api {delete} /api/ml/trained_models/:modelId Delete a trained model
* @apiName DeleteTrainedModel
* @apiDescription Deletes an existing trained model that is currently not referenced by an ingest pipeline.
*/
router.delete(
{
Expand Down