Bump apidoc-markdown from v6.0.0 to v7.2.4

[watson]

Note to reviewers

See breaking changes and upgrade guide for apidoc-markdown version 7 here: https://github.com/rigwild/apidoc-markdown/releases/tag/v7.0.1

The reason why I remove the direct apidoc dependency is that apidoc-markdown now ships with apidoc itself and takes care of running apidoc internally. Hence why I also upgraded the command in the ML package.json that first runs apidoc and then apidoc-markdown.

I removed a bunch of stuff about apidoc from x-pack/plugins/transform/server/README.md because it seemed to just have been copied from x-pack/plugins/ml/server/routes/README.md and wasn't actually relevant for that plugin.

[elasticmachine]

Pinging @elastic/ml-ui (:ml)

[darnautov]

hi @watson, thanks for updating the apidoc markdown!

When I execute the yarn run apiDocs command I receive the following errors:

Expand the error output:

➜  ml git:(bump-apidoc-markdown) ✗ yarn run apiDocs
yarn run v1.22.19
$ yarn build:apiDocScripts && yarn generateHeader && cd ./server/routes/ && ../../../../../node_modules/.bin/apidoc-markdown --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/ML_API.mdx --header ./apidoc_scripts/header.md --template ./apidoc_scripts/template.md
$ cd server/routes/apidoc_scripts && ../../../../../../node_modules/.bin/tsc
../../../../../../packages/kbn-config-schema/src/internals/index.ts:10:15 - error TS2305: Module '"joi"' has no exported member 'JoiRoot'.

10 import type { JoiRoot, CustomHelpers } from 'joi';
                 ~~~~~~~

../../../../../../packages/kbn-config-schema/src/types/string_type.ts:39:15 - error TS2571: Object is of type 'unknown'.

39           if (value.length < options.minLength!) {
                 ~~~~~

../../../../../../packages/kbn-config-schema/src/types/string_type.ts:40:41 - error TS2571: Object is of type 'unknown'.

40             return `value has length [${value.length}] but it must have a minimum length of [${options.minLength}].`;
                                           ~~~~~

../../../../../../packages/kbn-config-schema/src/types/string_type.ts:49:15 - error TS2571: Object is of type 'unknown'.

49           if (value.length > options.maxLength!) {
                 ~~~~~

../../../../../../packages/kbn-config-schema/src/types/string_type.ts:50:41 - error TS2571: Object is of type 'unknown'.

50             return `value has length [${value.length}] but it must have a maximum length of [${options.maxLength}].`;
                                           ~~~~~

../../../../../../packages/kbn-config-schema/src/types/type.ts:123:13 - error TS2339: Property 'local' does not exist on type 'ErrorReport'.

123     const { local, code, path, value } = error;
                ~~~~~


Found 6 errors in 3 files.

Errors  Files
     1  ../../../../../../packages/kbn-config-schema/src/internals/index.ts:10
     4  ../../../../../../packages/kbn-config-schema/src/types/string_type.ts:39
     1  ../../../../../../packages/kbn-config-schema/src/types/type.ts:123

And the schema_extractor tests fails 🤔

Does it work fine in your setup?

[watson]

@darnautov thanks for reviewing. I mistakenly thought that this job would run during CI, so when that was all green I thought it was ok. But I get the same errors when running locally. I'll take a look...

[watson]

@darnautov I just now got back to this PR and after looking more into this I discovered that the issue you found with yarn run apiDocs also exists in main. So it's not related to this PR. So the big question is: Does anyone still use this? (cc @elastic/ml-ui)

The TS errors that you get actually doesn't even come from the part of the shell command that I edited but from the very beginning of the shell command: yarn build:apiDocScripts. If you just run that standalone you get the samme error.

[darnautov]

hey @watson, indeed you're right, the script is broken on main. Currently, it's used to build internal documentation and it hasn't been updated for a while. I'll create a PR to address it ASAP.

[watson]

@darnautov if you plan to fix the script in main soon, then I'll just wait until it's done and then merge main into this PR. If you think it will take a while before you have time (I can understand if it's not high priority), then I would prefer to either just merge this as is and cross our fingeres it will not make the future fixing of the script harder. Do you have any preferences?

[darnautov]

LGTM, let's merge this one and I'll take care of fixing the build step in a follow-up

[darnautov]

@elasticmachine merge upstream

[kibanamachine]

merge conflict between base and head

[kibana-ci]

💚 Build Succeeded

• Buildkite Build
• Commit: 729c37f

Metrics [docs]

Async chunks

Total size of all lazy-loaded chunks that will be downloaded as the user navigates the app

id	before	after	diff
maps	2.7MB	2.7MB	+155.0B
mapsEms	124.1KB	124.2KB	+156.0B
securitySolution	10.1MB	10.1MB	+465.0B
total			+776.0B

Unknown metric groups

ESLint disabled in files

id	before	after	diff
osquery	1	2	+1

ESLint disabled line counts

id	before	after	diff
enterpriseSearch	19	21	+2
fleet	60	66	+6
osquery	109	115	+6
securitySolution	445	451	+6
total			+20

Total ESLint disabled count

id	before	after	diff
enterpriseSearch	20	22	+2
fleet	69	75	+6
osquery	110	117	+7
securitySolution	521	527	+6
total			+21

History

• 💛 Build #93587 was flaky c54e4a3
• 💚 Build #92545 succeeded 6ce3a5d
• 💚 Build #84312 succeeded c2cd823
• 💚 Build #83911 succeeded 1bfbe76
• 💚 Build #82738 succeeded 749fe5613eefeb38d4925df7be5a8821e2a798e7

To update your PR or re-run it, just comment with:
@elasticmachine merge upstream

cc @watson

[kibanamachine]

💔 All backports failed

Status	Branch	Result
❌	7.17	Backport failed because of merge conflicts You might need to backport the following PRs to 7.17: - Upgrade node-sass to 8.0.0 (#145355)
❌	8.5	Backport failed because of merge conflicts
❌	8.6	Backport failed because of merge conflicts

Manual backport

To create the backport manually run:

node scripts/backport --pr 144007

Questions ?

Please refer to the Backport tool documentation

[kibanamachine]

Friendly reminder: Looks like this PR hasn’t been backported yet.
To create automatically backports add the label auto-backport or prevent reminders by adding the backport:skip label.
You can also create backports manually by running node scripts/backport --pr 144007 locally

[kibanamachine]

Friendly reminder: Looks like this PR hasn’t been backported yet.
To create automatically backports add the label auto-backport or prevent reminders by adding the backport:skip label.
You can also create backports manually by running node scripts/backport --pr 144007 locally

[kibanamachine]

Friendly reminder: Looks like this PR hasn’t been backported yet.
To create automatically backports add the label auto-backport or prevent reminders by adding the backport:skip label.
You can also create backports manually by running node scripts/backport --pr 144007 locally

[kibanamachine]

Friendly reminder: Looks like this PR hasn’t been backported yet.
To create automatically backports add the label auto-backport or prevent reminders by adding the backport:skip label.
You can also create backports manually by running node scripts/backport --pr 144007 locally

[kibanamachine]

💔 All backports failed

Status	Branch	Result
❌	7.17	Backport failed because of merge conflicts
❌	8.5	Backport failed because of merge conflicts
❌	8.6	Backport failed because of merge conflicts

Manual backport

To create the backport manually run:

node scripts/backport --pr 144007

Questions ?

Please refer to the Backport tool documentation

[kibanamachine]

Looks like this PR has a backport PR but it still hasn't been merged. Please merge it ASAP to keep the branches relatively in sync.

[kibanamachine]

Looks like this PR has a backport PR but it still hasn't been merged. Please merge it ASAP to keep the branches relatively in sync.