[Security Assistant] Added examples for necessary AI Assistant OpenAPI docs #219883
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
stephmilovic
added
release_note:skip
Contributor
|
Pinging @elastic/security-solution (Team: SecuritySolution) |
Collaborator
🎉 Snyk checks have passed. No issues have been found so far.✅ security/snyk check is complete. No issues have been found. (View Details) ✅ license/snyk check is complete. No issues have been found. (View Details) |
Contributor
Author
|
@elasticmachine merge upstream |
…into doc_openapi_updates
spong
reviewed
May 2, 2025
...sistant-common/impl/schemas/anonymization_fields/bulk_crud_anonymization_fields_route.gen.ts
Show resolved
Hide resolved
spong
reviewed
May 2, 2025
...ckages/shared/kbn-elastic-assistant-common/impl/schemas/chat/post_chat_complete_route.gen.ts
Show resolved
Hide resolved
…into doc_openapi_updates
Contributor
Author
|
Ok i think I've got it now. Could you please recheck @natasha-moore-elastic |
Contributor
💛 Build succeeded, but was flaky
Failed CI StepsTest Failures
Metrics [docs]Module Count
Public APIs missing comments
Async chunks
History
|
Contributor
Looks great, thank you! |
natasha-moore-elastic
approved these changes
May 9, 2025
Contributor
|
Starting backport for target branches: 8.18, 8.19, 9.0 |
Contributor
💔 All backports failed
Manual backportTo create the backport manually run: Questions ?Please refer to the Backport tool documentation |
stephmilovic
added a commit
to stephmilovic/kibana
that referenced
this pull request
May 9, 2025
…I docs (elastic#219883) (cherry picked from commit 214c5f0) # Conflicts: # oas_docs/output/kibana.serverless.yaml # oas_docs/output/kibana.yaml # x-pack/platform/packages/shared/kbn-elastic-assistant-common/docs/openapi/ess/elastic_assistant_api_2023_10_31.bundled.schema.yaml # x-pack/platform/packages/shared/kbn-elastic-assistant-common/docs/openapi/serverless/elastic_assistant_api_2023_10_31.bundled.schema.yaml # x-pack/platform/packages/shared/kbn-elastic-assistant-common/impl/schemas/actions_connector/post_actions_connector_execute_route.gen.ts # x-pack/platform/packages/shared/kbn-elastic-assistant-common/impl/schemas/actions_connector/post_actions_connector_execute_route.schema.yaml # x-pack/platform/packages/shared/kbn-elastic-assistant-common/impl/schemas/alert_summary/bulk_crud_alert_summary_route.gen.ts # x-pack/platform/packages/shared/kbn-elastic-assistant-common/impl/schemas/alert_summary/bulk_crud_alert_summary_route.schema.yaml # x-pack/platform/packages/shared/kbn-elastic-assistant-common/impl/schemas/attack_discovery/attack_discovery_alert.gen.ts # x-pack/platform/packages/shared/kbn-elastic-assistant-common/impl/schemas/attack_discovery/attack_discovery_alert.schema.yaml # x-pack/platform/packages/shared/kbn-elastic-assistant-common/impl/schemas/attack_discovery/get_attack_discovery_generations.route.gen.ts # x-pack/platform/packages/shared/kbn-elastic-assistant-common/impl/schemas/attack_discovery/get_attack_discovery_generations.route.schema.yaml # x-pack/platform/packages/shared/kbn-elastic-assistant-common/impl/schemas/attack_discovery/schedules.gen.ts # x-pack/platform/packages/shared/kbn-elastic-assistant-common/impl/schemas/attack_discovery/schedules.schema.yaml # x-pack/platform/packages/shared/kbn-elastic-assistant-common/impl/schemas/chat/post_chat_complete_route.schema.yaml # x-pack/platform/packages/shared/kbn-elastic-assistant-common/impl/schemas/common_attributes.gen.ts # x-pack/platform/packages/shared/kbn-elastic-assistant-common/impl/schemas/common_attributes.schema.yaml # x-pack/platform/packages/shared/kbn-elastic-assistant-common/impl/schemas/conversations/common_attributes.gen.ts # x-pack/platform/packages/shared/kbn-elastic-assistant/impl/assistant/quick_prompts/quick_prompt_settings/quick_prompt_editor.tsx # x-pack/platform/packages/shared/kbn-elastic-assistant/impl/assistant/quick_prompts/quick_prompt_settings/quick_prompt_settings.tsx # x-pack/platform/packages/shared/kbn-elastic-assistant/impl/assistant/quick_prompts/quick_prompt_settings_management/index.tsx # x-pack/platform/packages/shared/kbn-elastic-assistant/impl/assistant/settings/use_settings_updater/use_anonymization_updater.ts # x-pack/platform/packages/shared/kbn-elastic-assistant/impl/assistant/settings/use_settings_updater/use_quick_prompt_updater.ts # x-pack/platform/packages/shared/kbn-elastic-assistant/impl/assistant/settings/use_settings_updater/use_system_prompt_updater.ts # x-pack/platform/packages/shared/kbn-elastic-assistant/impl/assistant/use_data_stream_apis.tsx # x-pack/solutions/security/plugins/elastic_assistant/server/__mocks__/alert_summary.mock.ts # x-pack/solutions/security/plugins/elastic_assistant/server/__mocks__/request.ts # x-pack/solutions/security/plugins/elastic_assistant/server/ai_assistant_data_clients/alert_summary/helpers.ts # x-pack/solutions/security/plugins/elastic_assistant/server/lib/defend_insights/evaluation/index.ts # x-pack/solutions/security/plugins/elastic_assistant/server/lib/defend_insights/graphs/default_defend_insights_graph/index.ts # x-pack/solutions/security/plugins/elastic_assistant/server/lib/defend_insights/graphs/default_defend_insights_graph/mock/mock_anonymization_fields.ts # x-pack/solutions/security/plugins/elastic_assistant/server/lib/defend_insights/graphs/default_defend_insights_graph/nodes/retriever/anonymized_events_retriever/index.ts # x-pack/solutions/security/plugins/elastic_assistant/server/lib/defend_insights/graphs/default_defend_insights_graph/nodes/retriever/index.ts # x-pack/solutions/security/plugins/elastic_assistant/server/routes/alert_summary/bulk_actions_route.ts # x-pack/solutions/security/plugins/elastic_assistant/server/routes/alert_summary/find_route.ts # x-pack/solutions/security/plugins/security_solution/public/flyout/ai_for_soc/hooks/use_bulk_update_alert_summary.tsx # x-pack/solutions/security/plugins/security_solution/public/flyout/ai_for_soc/hooks/use_fetch_alert_summary.tsx # x-pack/solutions/security/plugins/security_solution/server/assistant/tools/defend_insights/get_events/index.ts # x-pack/test/security_solution_cypress/cypress/e2e/ai_assistant/prompts.cy.ts
stephmilovic
added a commit
to stephmilovic/kibana
that referenced
this pull request
May 9, 2025
…I docs (elastic#219883) (cherry picked from commit 214c5f0) # Conflicts: # oas_docs/output/kibana.serverless.yaml # x-pack/platform/packages/shared/kbn-elastic-assistant-common/impl/schemas/actions_connector/post_actions_connector_execute_route.gen.ts # x-pack/platform/packages/shared/kbn-elastic-assistant-common/impl/schemas/actions_connector/post_actions_connector_execute_route.schema.yaml # x-pack/platform/packages/shared/kbn-elastic-assistant-common/impl/schemas/alert_summary/bulk_crud_alert_summary_route.gen.ts # x-pack/platform/packages/shared/kbn-elastic-assistant-common/impl/schemas/alert_summary/bulk_crud_alert_summary_route.schema.yaml # x-pack/platform/packages/shared/kbn-elastic-assistant-common/impl/schemas/common_attributes.gen.ts # x-pack/platform/packages/shared/kbn-elastic-assistant-common/impl/schemas/common_attributes.schema.yaml # x-pack/platform/packages/shared/kbn-elastic-assistant/impl/assistant/prompt_editor/system_prompt/select_system_prompt/index.tsx # x-pack/solutions/security/plugins/elastic_assistant/server/__mocks__/alert_summary.mock.ts # x-pack/solutions/security/plugins/elastic_assistant/server/__mocks__/request.ts # x-pack/solutions/security/plugins/elastic_assistant/server/ai_assistant_data_clients/alert_summary/helpers.ts # x-pack/solutions/security/plugins/elastic_assistant/server/lib/defend_insights/evaluation/index.ts # x-pack/solutions/security/plugins/elastic_assistant/server/lib/defend_insights/graphs/default_defend_insights_graph/index.ts # x-pack/solutions/security/plugins/elastic_assistant/server/lib/defend_insights/graphs/default_defend_insights_graph/mock/mock_anonymization_fields.ts # x-pack/solutions/security/plugins/elastic_assistant/server/lib/defend_insights/graphs/default_defend_insights_graph/nodes/retriever/anonymized_events_retriever/index.ts # x-pack/solutions/security/plugins/elastic_assistant/server/lib/defend_insights/graphs/default_defend_insights_graph/nodes/retriever/index.ts # x-pack/solutions/security/plugins/elastic_assistant/server/routes/alert_summary/bulk_actions_route.ts # x-pack/solutions/security/plugins/elastic_assistant/server/routes/alert_summary/find_route.ts # x-pack/solutions/security/plugins/security_solution/public/flyout/ai_for_soc/hooks/use_bulk_update_alert_summary.tsx # x-pack/solutions/security/plugins/security_solution/public/flyout/ai_for_soc/hooks/use_fetch_alert_summary.tsx # x-pack/solutions/security/plugins/security_solution/server/assistant/tools/defend_insights/get_events/index.ts
Contributor
Author
💚 All backports created successfully
Note: Successful backport PRs will be merged automatically after passing CI. Questions ?Please refer to the Backport tool documentation |
stephmilovic
added a commit
to stephmilovic/kibana
that referenced
this pull request
May 9, 2025
…I docs (elastic#219883) (cherry picked from commit 214c5f0) # Conflicts: # oas_docs/output/kibana.serverless.yaml # oas_docs/output/kibana.yaml # x-pack/platform/packages/shared/kbn-elastic-assistant-common/docs/openapi/ess/elastic_assistant_api_2023_10_31.bundled.schema.yaml # x-pack/platform/packages/shared/kbn-elastic-assistant-common/docs/openapi/serverless/elastic_assistant_api_2023_10_31.bundled.schema.yaml # x-pack/platform/packages/shared/kbn-elastic-assistant-common/impl/schemas/actions_connector/post_actions_connector_execute_route.gen.ts # x-pack/platform/packages/shared/kbn-elastic-assistant-common/impl/schemas/actions_connector/post_actions_connector_execute_route.schema.yaml # x-pack/platform/packages/shared/kbn-elastic-assistant-common/impl/schemas/alert_summary/bulk_crud_alert_summary_route.gen.ts # x-pack/platform/packages/shared/kbn-elastic-assistant-common/impl/schemas/alert_summary/bulk_crud_alert_summary_route.schema.yaml # x-pack/platform/packages/shared/kbn-elastic-assistant-common/impl/schemas/attack_discovery/attack_discovery_alert.gen.ts # x-pack/platform/packages/shared/kbn-elastic-assistant-common/impl/schemas/attack_discovery/attack_discovery_alert.schema.yaml # x-pack/platform/packages/shared/kbn-elastic-assistant-common/impl/schemas/attack_discovery/get_attack_discovery_generations.route.gen.ts # x-pack/platform/packages/shared/kbn-elastic-assistant-common/impl/schemas/attack_discovery/get_attack_discovery_generations.route.schema.yaml # x-pack/platform/packages/shared/kbn-elastic-assistant-common/impl/schemas/attack_discovery/schedules.gen.ts # x-pack/platform/packages/shared/kbn-elastic-assistant-common/impl/schemas/attack_discovery/schedules.schema.yaml # x-pack/platform/packages/shared/kbn-elastic-assistant-common/impl/schemas/chat/post_chat_complete_route.schema.yaml # x-pack/platform/packages/shared/kbn-elastic-assistant-common/impl/schemas/common_attributes.gen.ts # x-pack/platform/packages/shared/kbn-elastic-assistant-common/impl/schemas/common_attributes.schema.yaml # x-pack/platform/packages/shared/kbn-elastic-assistant-common/impl/schemas/conversations/common_attributes.gen.ts # x-pack/platform/packages/shared/kbn-elastic-assistant/impl/assistant/prompt_editor/system_prompt/select_system_prompt/index.tsx # x-pack/platform/packages/shared/kbn-elastic-assistant/impl/assistant/quick_prompts/quick_prompt_settings/quick_prompt_editor.tsx # x-pack/platform/packages/shared/kbn-elastic-assistant/impl/assistant/quick_prompts/quick_prompt_settings/quick_prompt_settings.tsx # x-pack/platform/packages/shared/kbn-elastic-assistant/impl/assistant/quick_prompts/quick_prompt_settings_management/index.tsx # x-pack/platform/packages/shared/kbn-elastic-assistant/impl/assistant/settings/use_settings_updater/use_anonymization_updater.ts # x-pack/platform/packages/shared/kbn-elastic-assistant/impl/assistant/settings/use_settings_updater/use_quick_prompt_updater.ts # x-pack/platform/packages/shared/kbn-elastic-assistant/impl/assistant/settings/use_settings_updater/use_system_prompt_updater.ts # x-pack/platform/packages/shared/kbn-elastic-assistant/impl/assistant/use_data_stream_apis.tsx # x-pack/solutions/security/plugins/elastic_assistant/server/__mocks__/alert_summary.mock.ts # x-pack/solutions/security/plugins/elastic_assistant/server/__mocks__/request.ts # x-pack/solutions/security/plugins/elastic_assistant/server/ai_assistant_data_clients/alert_summary/helpers.ts # x-pack/solutions/security/plugins/elastic_assistant/server/lib/defend_insights/evaluation/index.ts # x-pack/solutions/security/plugins/elastic_assistant/server/lib/defend_insights/graphs/default_defend_insights_graph/index.ts # x-pack/solutions/security/plugins/elastic_assistant/server/lib/defend_insights/graphs/default_defend_insights_graph/mock/mock_anonymization_fields.ts # x-pack/solutions/security/plugins/elastic_assistant/server/lib/defend_insights/graphs/default_defend_insights_graph/nodes/retriever/anonymized_events_retriever/index.ts # x-pack/solutions/security/plugins/elastic_assistant/server/lib/defend_insights/graphs/default_defend_insights_graph/nodes/retriever/index.ts # x-pack/solutions/security/plugins/elastic_assistant/server/routes/alert_summary/bulk_actions_route.ts # x-pack/solutions/security/plugins/elastic_assistant/server/routes/alert_summary/find_route.ts # x-pack/solutions/security/plugins/security_solution/public/flyout/ai_for_soc/hooks/use_bulk_update_alert_summary.tsx # x-pack/solutions/security/plugins/security_solution/public/flyout/ai_for_soc/hooks/use_fetch_alert_summary.tsx # x-pack/solutions/security/plugins/security_solution/server/assistant/tools/defend_insights/get_events/index.ts # x-pack/test/security_solution_cypress/cypress/e2e/ai_assistant/prompts.cy.ts
kdelemme
pushed a commit
to kdelemme/kibana
that referenced
this pull request
May 9, 2025
stephmilovic
added a commit
that referenced
this pull request
May 9, 2025
… OpenAPI docs (#219883) (#220711) # Backport This will backport the following commits from `main` to `8.19`: - [[Security Assistant] Added examples for necessary AI Assistant OpenAPI docs (#219883)](#219883) <!--- Backport version: 9.6.6 --> ### Questions ? Please refer to the [Backport tool documentation](https://github.com/sorenlouv/backport) <!--BACKPORT [{"author":{"name":"Steph Milovic","email":"[email protected]"},"sourceCommit":{"committedDate":"2025-05-09T14:47:44Z","message":"[Security Assistant] Added examples for necessary AI Assistant OpenAPI docs (#219883)","sha":"214c5f099e61a9e0c5e893e0c417d12636e3e000","branchLabelMapping":{"^v9.1.0$":"main","^v(\\d+).(\\d+).\\d+$":"$1.$2"}},"sourcePullRequest":{"labels":["release_note:skip","Team: SecuritySolution","Team:Security Generative AI","backport:version","v9.1.0","v8.19.0","v9.0.1","v8.18.2"],"title":"[Security Assistant] Added examples for necessary AI Assistant OpenAPI docs","number":219883,"url":"https://github.com/elastic/kibana/pull/219883","mergeCommit":{"message":"[Security Assistant] Added examples for necessary AI Assistant OpenAPI docs (#219883)","sha":"214c5f099e61a9e0c5e893e0c417d12636e3e000"}},"sourceBranch":"main","suggestedTargetBranches":["8.19","9.0","8.18"],"targetPullRequestStates":[{"branch":"main","label":"v9.1.0","branchLabelMappingKey":"^v9.1.0$","isSourceBranch":true,"state":"MERGED","url":"https://github.com/elastic/kibana/pull/219883","number":219883,"mergeCommit":{"message":"[Security Assistant] Added examples for necessary AI Assistant OpenAPI docs (#219883)","sha":"214c5f099e61a9e0c5e893e0c417d12636e3e000"}},{"branch":"8.19","label":"v8.19.0","branchLabelMappingKey":"^v(\\d+).(\\d+).\\d+$","isSourceBranch":false,"state":"NOT_CREATED"},{"branch":"9.0","label":"v9.0.1","branchLabelMappingKey":"^v(\\d+).(\\d+).\\d+$","isSourceBranch":false,"state":"NOT_CREATED"},{"branch":"8.18","label":"v8.18.2","branchLabelMappingKey":"^v(\\d+).(\\d+).\\d+$","isSourceBranch":false,"state":"NOT_CREATED"}]}] BACKPORT-->
stephmilovic
added a commit
that referenced
this pull request
May 9, 2025
…OpenAPI docs (#219883) (#220710) # Backport This will backport the following commits from `main` to `9.0`: - [[Security Assistant] Added examples for necessary AI Assistant OpenAPI docs (#219883)](#219883) <!--- Backport version: 9.6.6 --> ### Questions ? Please refer to the [Backport tool documentation](https://github.com/sorenlouv/backport) <!--BACKPORT [{"author":{"name":"Steph Milovic","email":"[email protected]"},"sourceCommit":{"committedDate":"2025-05-09T14:47:44Z","message":"[Security Assistant] Added examples for necessary AI Assistant OpenAPI docs (#219883)","sha":"214c5f099e61a9e0c5e893e0c417d12636e3e000","branchLabelMapping":{"^v9.1.0$":"main","^v(\\d+).(\\d+).\\d+$":"$1.$2"}},"sourcePullRequest":{"labels":["release_note:skip","Team: SecuritySolution","Team:Security Generative AI","backport:version","v9.1.0","v8.19.0","v9.0.1","v8.18.2"],"title":"[Security Assistant] Added examples for necessary AI Assistant OpenAPI docs","number":219883,"url":"https://github.com/elastic/kibana/pull/219883","mergeCommit":{"message":"[Security Assistant] Added examples for necessary AI Assistant OpenAPI docs (#219883)","sha":"214c5f099e61a9e0c5e893e0c417d12636e3e000"}},"sourceBranch":"main","suggestedTargetBranches":["8.19","9.0","8.18"],"targetPullRequestStates":[{"branch":"main","label":"v9.1.0","branchLabelMappingKey":"^v9.1.0$","isSourceBranch":true,"state":"MERGED","url":"https://github.com/elastic/kibana/pull/219883","number":219883,"mergeCommit":{"message":"[Security Assistant] Added examples for necessary AI Assistant OpenAPI docs (#219883)","sha":"214c5f099e61a9e0c5e893e0c417d12636e3e000"}},{"branch":"8.19","label":"v8.19.0","branchLabelMappingKey":"^v(\\d+).(\\d+).\\d+$","isSourceBranch":false,"state":"NOT_CREATED"},{"branch":"9.0","label":"v9.0.1","branchLabelMappingKey":"^v(\\d+).(\\d+).\\d+$","isSourceBranch":false,"state":"NOT_CREATED"},{"branch":"8.18","label":"v8.18.2","branchLabelMappingKey":"^v(\\d+).(\\d+).\\d+$","isSourceBranch":false,"state":"NOT_CREATED"}]}] BACKPORT--> --------- Co-authored-by: kibanamachine <[email protected]>
stephmilovic
added a commit
that referenced
this pull request
May 9, 2025
… OpenAPI docs (#219883) (#220712) # Backport This will backport the following commits from `main` to `8.18`: - [[Security Assistant] Added examples for necessary AI Assistant OpenAPI docs (#219883)](#219883) <!--- Backport version: 9.6.6 --> ### Questions ? Please refer to the [Backport tool documentation](https://github.com/sorenlouv/backport) <!--BACKPORT [{"author":{"name":"Steph Milovic","email":"[email protected]"},"sourceCommit":{"committedDate":"2025-05-09T14:47:44Z","message":"[Security Assistant] Added examples for necessary AI Assistant OpenAPI docs (#219883)","sha":"214c5f099e61a9e0c5e893e0c417d12636e3e000","branchLabelMapping":{"^v9.1.0$":"main","^v(\\d+).(\\d+).\\d+$":"$1.$2"}},"sourcePullRequest":{"labels":["release_note:skip","Team: SecuritySolution","Team:Security Generative AI","backport:version","v9.1.0","v8.19.0","v9.0.1","v8.18.2"],"title":"[Security Assistant] Added examples for necessary AI Assistant OpenAPI docs","number":219883,"url":"https://github.com/elastic/kibana/pull/219883","mergeCommit":{"message":"[Security Assistant] Added examples for necessary AI Assistant OpenAPI docs (#219883)","sha":"214c5f099e61a9e0c5e893e0c417d12636e3e000"}},"sourceBranch":"main","suggestedTargetBranches":["8.19","9.0","8.18"],"targetPullRequestStates":[{"branch":"main","label":"v9.1.0","branchLabelMappingKey":"^v9.1.0$","isSourceBranch":true,"state":"MERGED","url":"https://github.com/elastic/kibana/pull/219883","number":219883,"mergeCommit":{"message":"[Security Assistant] Added examples for necessary AI Assistant OpenAPI docs (#219883)","sha":"214c5f099e61a9e0c5e893e0c417d12636e3e000"}},{"branch":"8.19","label":"v8.19.0","branchLabelMappingKey":"^v(\\d+).(\\d+).\\d+$","isSourceBranch":false,"state":"NOT_CREATED"},{"branch":"9.0","label":"v9.0.1","branchLabelMappingKey":"^v(\\d+).(\\d+).\\d+$","isSourceBranch":false,"state":"NOT_CREATED"},{"branch":"8.18","label":"v8.18.2","branchLabelMappingKey":"^v(\\d+).(\\d+).\\d+$","isSourceBranch":false,"state":"NOT_CREATED"}]}] BACKPORT--> --------- Co-authored-by: kibanamachine <[email protected]>
akowalska622
pushed a commit
to akowalska622/kibana
that referenced
this pull request
May 29, 2025
qn895
pushed a commit
to qn895/kibana
that referenced
this pull request
Jun 3, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
8 participants
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
As part of the effort to add missing content for Security APIs, this PR introduces a few missing request, response, and parameter examples for Security AI Assistant APIs.
The affected APIs include:
The issue is documented here, and the specific APIs called out for updates are in the linked spreadsheet in the issue
How to Test
Run a local preview in bump, which shows what the output will look like in our production.
cd x-pack/platform/packages/shared/kbn-elastic-assistant-commonand then runnpm run openapi:generatefollowed bynpm run openapi:bundle. That last command gives you the path to the bundled file at the end that is used in the next step.bump preview docs/openapi/ess/elastic_assistant_api_2023_10_31.bundled.schema.yaml