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.

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

[HTTP/OAS] Add description in create rule request body #183564

Merged
merged 2 commits into from
May 21, 2024

Conversation

lcawl
Copy link
Contributor

@lcawl lcawl commented May 15, 2024

Summary

Relates to #180056

This PR moves some descriptions from the manually curated OpenAPI document (https://github.com/elastic/kibana/tree/main/x-pack/plugins/alerting/docs/openapi) into the code for automated OpenAPI docs generation.

How to test

Per #181277:

  1. Start Elasticsearch (e.g. yarn es snapshot --license trial)
  2. Add server.oas.enabled: true to kibana.dev.yml
  3. Start Kibana (e.g. yarn start --no-base-path)
  4. curl -s -uelastic:changeme http://localhost:5601/api/oas\?pathStartsWith\=/api/alerting | jq > test.json

@lcawl lcawl added Feature:Alerting release_note:skip Skip the PR/issue when compiling release notes backport:skip This commit does not require backporting Team:ResponseOps Label for the ResponseOps team (formerly the Cases and Alerting teams) v8.14.0 labels May 15, 2024
@apmmachine
Copy link
Contributor

🤖 GitHub comments

Expand to view the GitHub comments

Just comment with:

  • /oblt-deploy : Deploy a Kibana instance using the Observability test environments.
  • run docs-build : Re-trigger the docs validation. (use unformatted text in the comment!)

@lcawl lcawl marked this pull request as ready for review May 15, 2024 23:59
@lcawl lcawl requested a review from a team as a code owner May 15, 2024 23:59
@elasticmachine
Copy link
Contributor

Pinging @elastic/response-ops (Team:ResponseOps)

@cnasikas
Copy link
Member

@elasticmachine merge upstream

@kibana-ci
Copy link
Collaborator

💚 Build Succeeded

Metrics [docs]

✅ unchanged

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

@lcawl lcawl merged commit 2c9a89e into elastic:main May 21, 2024
34 checks passed
@lcawl lcawl deleted the rule-descriptions branch May 21, 2024 14:39
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
backport:skip This commit does not require backporting Feature:Alerting release_note:skip Skip the PR/issue when compiling release notes Team:ResponseOps Label for the ResponseOps team (formerly the Cases and Alerting teams) v8.14.0 v8.15.0
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

6 participants