-
Notifications
You must be signed in to change notification settings - Fork 8.1k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
[OAS][DOCS] Temporarily omit security APIs from docs (#190467)
- Loading branch information
Showing
9 changed files
with
12,979 additions
and
47,931 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,8 +1,9 @@ | ||
The `bundle.json` and `bundle.serverless.json` files are generated automatically. | ||
See `node scripts/capture_oas_snapshot --help` for more info. | ||
|
||
The `output/kibana.serverless.yaml` file is a temporary OpenAPI document created by joining some manually-maintained files. | ||
To create it and lint it, run `make api-docs` or `make api-docs-serverless` and `make api-docs-lint` or `make api-docs-lint-serverless`. | ||
The `output/kibana.serverless.yaml` and `output/kibana.yaml` files join some manually-maintained files with the automatically generated files. | ||
To add integrate more files into this bundle, edit the appropriate `oas_docs/scripts/merge*.js` files. | ||
To generate the bundled files, run `make api-docs` (or `make api-docs-serverless` and `make api-docs-stateful`). | ||
To lint them, run `make api-docs-lint` (or `make api-docs-lint-serverless` and `make api-lint-stateful`). | ||
|
||
The `output/kibana.yaml` file is a temporary OpenAPI document created by joining some manually-maintained files. | ||
To create it and lint it, run `make api-docs` or `make api-docs-stateful` and `make api-docs-lint` or `make api-docs-lint-stateful`. | ||
To apply some overlays that perform some post-processing and append some content, run `make api-docs-overlay`. |
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
Oops, something went wrong.