kibana/oas_docs
Ying Mao a6c4120b35
[Response Ops][Alerting] Adding new value to warning reasons enum schema in rule saved object (#190743)
## Summary

We want to allow rule executors to report warnings back to the framework
and have them show up in the stack management UI. We currently have a
mechanism for this that is used by detection rules but they handle how
to show the warning in their custom UI so the warning does not appear in
the stack management UI. This PR adds a new value to the allow list of
"warning reasons". This should not warrant a schema version bump because
it is a new value for an existing enum but we need to do an intermediate
release so the new schema is recognized before we start setting it
anywhere. This PR is just for schema changes. PR that uses these schema
changes can be found here: https://github.com/elastic/kibana/pull/189312

---------

Co-authored-by: kibanamachine <42973632+kibanamachine@users.noreply.github.com>
Co-authored-by: Elastic Machine <elasticmachine@users.noreply.github.com>
2024-08-21 10:17:29 -04:00
..
examples [OAS][DOCS] Use automated alerting rule API documentation (#190205) 2024-08-15 17:07:56 -05:00
output [OAS][DOCS] Use automated alerting rule API documentation (#190205) 2024-08-15 17:07:56 -05:00
overlays [OAS][DOCS] Use automated alerting rule API documentation (#190205) 2024-08-15 17:07:56 -05:00
scripts [OAS][DOCS] Use automated alerting rule API documentation (#190205) 2024-08-15 17:07:56 -05:00
.spectral.yaml [OAS][DOCS] Use automated alerting rule API documentation (#190205) 2024-08-15 17:07:56 -05:00
bundle.json [Response Ops][Alerting] Adding new value to warning reasons enum schema in rule saved object (#190743) 2024-08-21 10:17:29 -04:00
bundle.serverless.json [Response Ops][Alerting] Adding new value to warning reasons enum schema in rule saved object (#190743) 2024-08-21 10:17:29 -04:00
kibana.info.serverless.yaml [OAS][DOCS] Use automated alerting rule API documentation (#190205) 2024-08-15 17:07:56 -05:00
kibana.info.yaml [OAS][DOCS] Use automated alerting rule API documentation (#190205) 2024-08-15 17:07:56 -05:00
makefile [OAS][DOCS] Use automated alerting rule API documentation (#190205) 2024-08-15 17:07:56 -05:00
README.md [OAS][DOCS] Temporarily omit security APIs from docs (#190467) 2024-08-14 11:52:18 -05:00

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 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).

To apply some overlays that perform some post-processing and append some content, run make api-docs-overlay.