-
Notifications
You must be signed in to change notification settings - Fork 8.3k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
[ML] Script to generate a content page for the ML Kibana API (#154538)
## Summary - Adds a script to generate a content page with ML Kibana API groups - Updates the `apiDocs` npm command
- Loading branch information
Showing
4 changed files
with
81 additions
and
2 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,3 +1,4 @@ | ||
scripts/apidoc_scripts/ML_API.mdx | ||
scripts/apidoc_scripts/ml_kibana_api.mdx | ||
scripts/apidoc_scripts/header.md | ||
apidoc_config.json |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
68 changes: 68 additions & 0 deletions
68
x-pack/plugins/ml/scripts/apidoc_scripts/content_page/content_page.ts
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,68 @@ | ||
/* | ||
* Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one | ||
* or more contributor license agreements. Licensed under the Elastic License | ||
* 2.0; you may not use this file except in compliance with the Elastic License | ||
* 2.0. | ||
*/ | ||
|
||
import * as fs from 'fs'; | ||
import * as path from 'path'; | ||
// @ts-ignore can only be default-imported using the 'esModuleInterop' flag | ||
import moment from 'moment'; | ||
import { kibanaPackageJson } from '@kbn/repo-info'; | ||
// eslint-disable-next-line import/no-extraneous-dependencies | ||
import { createDoc } from 'apidoc-light'; | ||
|
||
interface Group { | ||
anchor: string; | ||
text: string; | ||
} | ||
|
||
const getContent = (groups: Group[]) => { | ||
const groupsStr = groups | ||
.map(({ anchor, text }) => `- <DocLink id="uiMlApi" section="${anchor}" text="${text} API" />`) | ||
.join('\n'); | ||
|
||
return `--- | ||
id: uiMlKibanaRestApi | ||
slug: /ml-team/docs/ui/rest-api/ml-kibana-rest-api | ||
title: Machine Learning Kibana REST API | ||
image: https://source.unsplash.com/400x175/?Nature | ||
description: This page contains documentation for the ML Kibana REST API. | ||
date: ${moment().format('YYYY-MM-DD')} | ||
tags: ['machine learning','internal docs', 'UI'] | ||
--- | ||
_Updated for ${kibanaPackageJson.version}_ | ||
Some of the features of the Machine Learning (ML) Kibana plugin are provided via a REST API, which is ideal for creating an integration with the ML plugin. | ||
Each API is experimental and can include breaking changes in any version of the ML plugin, or might have been entirely removed from the plugin. | ||
- <DocLink id="uiMlApi" text="View complete API documentation" /> | ||
The following APIs are available: | ||
${groupsStr} | ||
`; | ||
}; | ||
|
||
export const generateContentPage = () => { | ||
const doc = createDoc({ | ||
src: path.resolve(__dirname, '..', '..', '..', 'server', 'routes'), | ||
config: path.resolve(__dirname, '..', 'apidoc_config', 'apidoc.json'), | ||
// if you don't want to generate the output files: | ||
dryRun: true, | ||
// if you don't want to see any log output: | ||
silent: true, | ||
}); | ||
|
||
const groups = [...new Set(doc.data.map((v) => v.group))].map((group) => { | ||
return { | ||
anchor: `-${group.toLowerCase()}`, | ||
text: group.replace(/([a-z])([A-Z])/g, '$1 $2'), | ||
}; | ||
}); | ||
|
||
fs.writeFileSync(path.resolve(__dirname, '..', 'ml_kibana_api.mdx'), getContent(groups)); | ||
}; |
9 changes: 9 additions & 0 deletions
9
x-pack/plugins/ml/scripts/apidoc_scripts/content_page/index.js
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,9 @@ | ||
/* | ||
* Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one | ||
* or more contributor license agreements. Licensed under the Elastic License | ||
* 2.0; you may not use this file except in compliance with the Elastic License | ||
* 2.0. | ||
*/ | ||
|
||
require('../../../../../../src/setup_node_env'); | ||
require('./content_page').generateContentPage(); |