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

[OAS][DOCS] Temporarily omit security APIs from docs #190467

Merged
merged 8 commits into from
Aug 14, 2024
Merged

[OAS][DOCS] Temporarily omit security APIs from docs #190467

Show file tree
Hide file tree
Changes from 3 commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
1b1971a
Update readme
lcawl Aug 13, 2024
7c03580
[OAS] Temporarily comment security APIs out of scripts
lcawl Aug 13, 2024
50e715d
Omit slo APIs; regenerate output
lcawl Aug 13, 2024
98cef8a
Re-add SLO in merge_ess_oas.js
lcawl Aug 14, 2024
b7dae60
Add tag overlay for slo
lcawl Aug 14, 2024
ae2ecda
Add staging scripts
lcawl Aug 14, 2024
186fa17
Merge branch 'main' into security-oas
lcawl Aug 14, 2024
8f950d5
Merge branch 'main' into security-oas
lcawl Aug 14, 2024
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
9 changes: 5 additions & 4 deletions oas_docs/README.md
View file
Open in desktop
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`.
Loading