[ResponseOps][Rules] Create the rule params package #196971
Merged
Conversation
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
cnasikas
added
Team:ResponseOps
|
Pinging @elastic/response-ops (Team:ResponseOps) |
cnasikas
added
the
release_note:skip
…t --include-path /api/status --include-path /api/alerting/rule/ --include-path /api/alerting/rules --include-path /api/actions --include-path /api/security/role --include-path /api/spaces --include-path /api/fleet --update'
cnasikas
commented
Oct 21, 2024
oas_docs/bundle.json
Outdated
| @@ -2413,7 +2414,6 @@ | |||
| "consumer", | |||
| "schedule", | |||
| "actions", | |||
| "params", | |||
There was a problem hiding this comment.
Why it get removed from the required? What is it because it has a defaultValue?
There was a problem hiding this comment.
I'd would think it's because of the default value, yes. You could try removing it and checking the bundle by yourself. Just follow the instructions in x-pack/plugins/alerting/docs/openapi/README.md
There was a problem hiding this comment.
Why did you add the defaultValue? Shouldn't it throw if it's missing in the request?
jcger
approved these changes
Oct 21, 2024
jcger
approved these changes
Oct 22, 2024
💚 Build Succeeded
Metrics [docs]Public APIs missing comments
History
cc @cnasikas |
|
Starting backport for target branches: 8.x |
kibanamachine
pushed a commit
to kibanamachine/kibana
that referenced
this pull request
Oct 23, 2024
## Summary This PR creates a package containing the schema of the params of all rule types. It starts as `schema.recordOf(schema.string(), schema.maybe(schema.any()))` which is the current one. In subsequent PRs, the schema will be updated to `schema.oneOf([apmRuleType, esQueryRuleType, ....])`. I also substituted the definition of `params` in the alerting plugin with the `params` exported from the package. Towards: elastic#187356 Fixes: elastic#195183 ### For maintainers - [x] This was checked for breaking API changes and was [labeled appropriately](https://www.elastic.co/guide/en/kibana/master/contributing.html#_add_your_labels) - [ ] This will appear in the **Release Notes** and follow the [guidelines](https://www.elastic.co/guide/en/kibana/master/contributing.html#kibana-release-notes-process) --------- Co-authored-by: kibanamachine <[email protected]> (cherry picked from commit a7a81c2)
💚 All backports created successfully
Note: Successful backport PRs will be merged automatically after passing CI. Questions ?Please refer to the Backport tool documentation |
kibanamachine
added a commit
that referenced
this pull request
Oct 23, 2024
…197367) # Backport This will backport the following commits from `main` to `8.x`: - [[ResponseOps][Rules] Create the rule params package (#196971)](#196971) <!--- Backport version: 9.4.3 --> ### Questions ? Please refer to the [Backport tool documentation](https://github.com/sqren/backport) <!--BACKPORT [{"author":{"name":"Christos Nasikas","email":"[email protected]"},"sourceCommit":{"committedDate":"2024-10-23T06:44:38Z","message":"[ResponseOps][Rules] Create the rule params package (#196971)\n\n## Summary\r\n\r\nThis PR creates a package containing the schema of the params of all\r\nrule types. It starts as `schema.recordOf(schema.string(),\r\nschema.maybe(schema.any()))` which is the current one. In subsequent\r\nPRs, the schema will be updated to `schema.oneOf([apmRuleType,\r\nesQueryRuleType, ....])`. I also substituted the definition of `params`\r\nin the alerting plugin with the `params` exported from the package.\r\n\r\nTowards: https://github.com/elastic/kibana/issues/187356\r\nFixes: https://github.com/elastic/kibana/issues/195183\r\n\r\n### For maintainers\r\n\r\n- [x] This was checked for breaking API changes and was [labeled\r\nappropriately](https://www.elastic.co/guide/en/kibana/master/contributing.html#_add_your_labels)\r\n- [ ] This will appear in the **Release Notes** and follow the\r\n[guidelines](https://www.elastic.co/guide/en/kibana/master/contributing.html#kibana-release-notes-process)\r\n\r\n---------\r\n\r\nCo-authored-by: kibanamachine <[email protected]>","sha":"a7a81c28973fd9b5bfc585b8e9b3cb7c5a86eb0b","branchLabelMapping":{"^v9.0.0$":"main","^v8.17.0$":"8.x","^v(\\d+).(\\d+).\\d+$":"$1.$2"}},"sourcePullRequest":{"labels":["release_note:skip","Team:ResponseOps","v9.0.0","Feature:Alerting/RulesFramework","backport:prev-minor","v8.17.0"],"title":"[ResponseOps][Rules] Create the rule params package","number":196971,"url":"https://github.com/elastic/kibana/pull/196971","mergeCommit":{"message":"[ResponseOps][Rules] Create the rule params package (#196971)\n\n## Summary\r\n\r\nThis PR creates a package containing the schema of the params of all\r\nrule types. It starts as `schema.recordOf(schema.string(),\r\nschema.maybe(schema.any()))` which is the current one. In subsequent\r\nPRs, the schema will be updated to `schema.oneOf([apmRuleType,\r\nesQueryRuleType, ....])`. I also substituted the definition of `params`\r\nin the alerting plugin with the `params` exported from the package.\r\n\r\nTowards: https://github.com/elastic/kibana/issues/187356\r\nFixes: https://github.com/elastic/kibana/issues/195183\r\n\r\n### For maintainers\r\n\r\n- [x] This was checked for breaking API changes and was [labeled\r\nappropriately](https://www.elastic.co/guide/en/kibana/master/contributing.html#_add_your_labels)\r\n- [ ] This will appear in the **Release Notes** and follow the\r\n[guidelines](https://www.elastic.co/guide/en/kibana/master/contributing.html#kibana-release-notes-process)\r\n\r\n---------\r\n\r\nCo-authored-by: kibanamachine <[email protected]>","sha":"a7a81c28973fd9b5bfc585b8e9b3cb7c5a86eb0b"}},"sourceBranch":"main","suggestedTargetBranches":["8.x"],"targetPullRequestStates":[{"branch":"main","label":"v9.0.0","branchLabelMappingKey":"^v9.0.0$","isSourceBranch":true,"state":"MERGED","url":"https://github.com/elastic/kibana/pull/196971","number":196971,"mergeCommit":{"message":"[ResponseOps][Rules] Create the rule params package (#196971)\n\n## Summary\r\n\r\nThis PR creates a package containing the schema of the params of all\r\nrule types. It starts as `schema.recordOf(schema.string(),\r\nschema.maybe(schema.any()))` which is the current one. In subsequent\r\nPRs, the schema will be updated to `schema.oneOf([apmRuleType,\r\nesQueryRuleType, ....])`. I also substituted the definition of `params`\r\nin the alerting plugin with the `params` exported from the package.\r\n\r\nTowards: https://github.com/elastic/kibana/issues/187356\r\nFixes: https://github.com/elastic/kibana/issues/195183\r\n\r\n### For maintainers\r\n\r\n- [x] This was checked for breaking API changes and was [labeled\r\nappropriately](https://www.elastic.co/guide/en/kibana/master/contributing.html#_add_your_labels)\r\n- [ ] This will appear in the **Release Notes** and follow the\r\n[guidelines](https://www.elastic.co/guide/en/kibana/master/contributing.html#kibana-release-notes-process)\r\n\r\n---------\r\n\r\nCo-authored-by: kibanamachine <[email protected]>","sha":"a7a81c28973fd9b5bfc585b8e9b3cb7c5a86eb0b"}},{"branch":"8.x","label":"v8.17.0","branchLabelMappingKey":"^v8.17.0$","isSourceBranch":false,"state":"NOT_CREATED"}]}] BACKPORT--> Co-authored-by: Christos Nasikas <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary
This PR creates a package containing the schema of the params of all rule types. It starts as
schema.recordOf(schema.string(), schema.maybe(schema.any()))which is the current one. In subsequent PRs, the schema will be updated toschema.oneOf([apmRuleType, esQueryRuleType, ....]). I also substituted the definition ofparamsin the alerting plugin with theparamsexported from the package.Towards: #187356
Fixes: #195183
For maintainers