[Connectors] Allow pre-configured connectors to opt-in to exposing their config by setting exposeConfig
#207654
Conversation
This file contains hidden or 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
…eir config by setting exposeConfig
YulNaumenko
added
release_note:enhancement
backport:version
pmuellr
reviewed
Jan 22, 2025
| @@ -32,6 +32,7 @@ const preconfiguredActionSchema = schema.object({ | |||
| actionTypeId: schema.string({ minLength: 1 }), | |||
| config: schema.recordOf(schema.string(), schema.any(), { defaultValue: {} }), | |||
| secrets: schema.recordOf(schema.string(), schema.any(), { defaultValue: {} }), | |||
| exposeConfig: schema.maybe(schema.boolean()), | |||
There was a problem hiding this comment.
Would it be better to make this schema.boolean({ defaultValue: false}) (or whatever)?
|
This doc should be updated to reflect the changes: https://github.com/elastic/kibana/blob/main/docs/management/connectors/pre-configured-connectors.asciidoc |
|
Starting backport for target branches: 8.x |
💚 Build Succeeded
Metrics [docs]Public APIs missing comments
cc @YulNaumenko |
kibanamachine
pushed a commit
to kibanamachine/kibana
that referenced
this pull request
Jan 22, 2025
…eir config by setting `exposeConfig` (elastic#207654) Resolves elastic#206433 Added optional `exposeConfig` field to the `preconfiguredActionSchema` to allow return the configuration for the pre-configured connectors, which set this value as `true`. This change is completely backward compatible, because this field is optional and all the connectors, which don't have the value will remain to work the same way as before the change (won't return the config). Changed get and getAll methods of the ActionsClient to reflect opt-in config based on the set `exposeConfig` value. (cherry picked from commit c15674f)
💚 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
Jan 23, 2025
…ing their config by setting `exposeConfig` (#207654) (#207902) # Backport This will backport the following commits from `main` to `8.x`: - [[Connectors] Allow pre-configured connectors to opt-in to exposing their config by setting `exposeConfig` (#207654)](#207654) <!--- Backport version: 9.4.3 --> ### Questions ? Please refer to the [Backport tool documentation](https://github.com/sqren/backport) <!--BACKPORT [{"author":{"name":"Yuliia Naumenko","email":"jo.naumenko@gmail.com"},"sourceCommit":{"committedDate":"2025-01-22T18:51:16Z","message":"[Connectors] Allow pre-configured connectors to opt-in to exposing their config by setting `exposeConfig` (#207654)\n\nResolves #206433\r\n\r\nAdded optional `exposeConfig` field to the `preconfiguredActionSchema`\r\nto allow return the configuration for the pre-configured connectors,\r\nwhich set this value as `true`.\r\nThis change is completely backward compatible, because this field is\r\noptional and all the connectors, which don't have the value will remain\r\nto work the same way as before the change (won't return the config).\r\n\r\nChanged get and getAll methods of the ActionsClient to reflect opt-in\r\nconfig based on the set `exposeConfig` value.","sha":"c15674f6d1e670b4210e31031ed93a8c95fdba3b","branchLabelMapping":{"^v9.0.0$":"main","^v8.18.0$":"8.x","^v(\\d+).(\\d+).\\d+$":"$1.$2"}},"sourcePullRequest":{"labels":["release_note:enhancement","v9.0.0","backport:version","8.18 candidate","v8.18.0"],"title":"[Connectors] Allow pre-configured connectors to opt-in to exposing their config by setting `exposeConfig`","number":207654,"url":"https://github.com/elastic/kibana/pull/207654","mergeCommit":{"message":"[Connectors] Allow pre-configured connectors to opt-in to exposing their config by setting `exposeConfig` (#207654)\n\nResolves #206433\r\n\r\nAdded optional `exposeConfig` field to the `preconfiguredActionSchema`\r\nto allow return the configuration for the pre-configured connectors,\r\nwhich set this value as `true`.\r\nThis change is completely backward compatible, because this field is\r\noptional and all the connectors, which don't have the value will remain\r\nto work the same way as before the change (won't return the config).\r\n\r\nChanged get and getAll methods of the ActionsClient to reflect opt-in\r\nconfig based on the set `exposeConfig` value.","sha":"c15674f6d1e670b4210e31031ed93a8c95fdba3b"}},"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/207654","number":207654,"mergeCommit":{"message":"[Connectors] Allow pre-configured connectors to opt-in to exposing their config by setting `exposeConfig` (#207654)\n\nResolves #206433\r\n\r\nAdded optional `exposeConfig` field to the `preconfiguredActionSchema`\r\nto allow return the configuration for the pre-configured connectors,\r\nwhich set this value as `true`.\r\nThis change is completely backward compatible, because this field is\r\noptional and all the connectors, which don't have the value will remain\r\nto work the same way as before the change (won't return the config).\r\n\r\nChanged get and getAll methods of the ActionsClient to reflect opt-in\r\nconfig based on the set `exposeConfig` value.","sha":"c15674f6d1e670b4210e31031ed93a8c95fdba3b"}},{"branch":"8.x","label":"v8.18.0","branchLabelMappingKey":"^v8.18.0$","isSourceBranch":false,"state":"NOT_CREATED"}]}] BACKPORT--> Co-authored-by: Yuliia Naumenko <jo.naumenko@gmail.com>
viduni94
pushed a commit
to viduni94/kibana
that referenced
this pull request
Jan 23, 2025
…eir config by setting `exposeConfig` (elastic#207654) Resolves elastic#206433 Added optional `exposeConfig` field to the `preconfiguredActionSchema` to allow return the configuration for the pre-configured connectors, which set this value as `true`. This change is completely backward compatible, because this field is optional and all the connectors, which don't have the value will remain to work the same way as before the change (won't return the config). Changed get and getAll methods of the ActionsClient to reflect opt-in config based on the set `exposeConfig` value.
KOTungseth
added
Feature:Actions
Team:ResponseOps
|
Pinging @elastic/response-ops (Team:ResponseOps) |
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.
Resolves #206433
Added optional
exposeConfigfield to thepreconfiguredActionSchemato allow return the configuration for the pre-configured connectors, which set this value astrue.This change is completely backward compatible, because this field is optional and all the connectors, which don't have the value will remain to work the same way as before the change (won't return the config).
Changed get and getAll methods of the ActionsClient to reflect opt-in config based on the set
exposeConfigvalue.