[Security Assistant] Fix Knowledge Base API

[patrykkopycinski]

Summary

Fixes bugs related to Security Assistant Knowledge Base API

[KDKHD]

🚀

[e40pud]

Changes related to user profile ID looks great and should work now!

I tested some other routes and noticed next issues:

1. KB entry by ID APIs:

I see that we report a few routes in our openapi files a few routes that are not available

• GET route does not exist at all in our code
• DELETE route exists, but not registered: x-pack/solutions/security/plugins/elastic_assistant/server/routes/knowledge_base/entries/delete_route.ts
• UPDATE route exists, but not registered: x-pack/solutions/security/plugins/elastic_assistant/server/routes/knowledge_base/entries/update_route.ts

2. Bulk actions - CREATE

I bumped into this error which happens once user created private entry and then tries to create a new one via bulk actions:

After some investigation, I've noticed that we have an issue within our code:

const result = await kbDataClient?.findDocuments<EsKnowledgeBaseEntrySchema>({
              perPage: 100,
              page: 1,
              filter: `users:{ id: "${authenticatedUser?.profile_uid}" }`,
              fields: [],
            });
            if (result?.data != null && result.total > 0) {
              return assistantResponse.error({
                statusCode: 409,
                body: `Knowledge Base Entry id's: "${transformESSearchToKnowledgeBaseEntry(
                  result.data
                )
                  .map((c) => c.id)
                  .join(',')}" already exists`,
              });
            }

Here we check whether user has document entries and if there are some existing entries we throw an 409 error in this case and do no allow user to create new entries via bulk CREATE action.

3. Bulk actions - UPDATE

I still see the issue where the document entry disappears after the bulk update. It happens when during the update I set "kbResource": "string", "source": "string". Even though those values are probably invalid and should not be passed, I think we should return bad request response or correct those values before the update. Also, as an option we could remove those attributes from the list of allowed properties to be updated.

Screen.Recording.2025-02-17.at.14.25.05.-.1080.mov

[e40pud]

@patrykkopycinski I checked APIs again and most routes work as expected!

Just two notes related to the "update entry by id" route:

1. We require to pass entry id in the body even though it is part of the URL path parameters. I think it should not be mandatory within the body in this route.

2. Right now it is possible to update entry from global to private via direct API call (I guess this also applies to update via bulk actions). In this case the global entry will disappear and only private entry will exist. When we do the same via UI, we keep global entry and create a copy as a private entry. We show the modal saying Changing a knowledge base entry from global to private will create a private copy of the original global entry. Please delete the global entry if you would like to revoke the content for other users.. I was wondering if we should handle this case within API as well and create a copy entry or just allow users to update entry from global to private. I lean towards keeping current API behaviour, but just wanted to pointed it out and make sure it is expected. cc @jamesspi

[patrykkopycinski]

Sorry all for the ping, Github resolve conflicts 🤦

[kibanamachine]

Starting backport for target branches: 8.18, 9.0

https://github.com/elastic/kibana/actions/runs/13532636265

[elasticmachine]

💚 Build Succeeded

• Buildkite Build
• Commit: 52bb60e

Metrics [docs]

Public APIs missing comments

Total count of every public API that lacks a comment. Target amount is 0. Run node scripts/build_api_docs --plugin [yourplugin] --stats comments for more detailed information.

id	before	after	diff
@kbn/elastic-assistant-common	429	434	+5

Async chunks

Total size of all lazy-loaded chunks that will be downloaded as the user navigates the app

id	before	after	diff
securitySolution	8.9MB	8.9MB	+181.0B

Unknown metric groups

API count

id	before	after	diff
@kbn/elastic-assistant-common	500	506	+6

ESLint disabled line counts

id	before	after	diff
@kbn/test-suites-xpack	720	721	+1

Total ESLint disabled count

id	before	after	diff
@kbn/test-suites-xpack	746	747	+1

History

• 💔 Build #279221 failed cfddb12
• 💔 Build #279196 failed 2e60771
• 💔 Build #279087 failed b062054
• 💔 Build #278977 failed 3b689f3
• 💔 Build #278952 failed 4a88e6a

[kibanamachine]

💚 All backports created successfully

Status	Branch	Result
✅	8.18
✅	9.0

Note: Successful backport PRs will be merged automatically after passing CI.

Questions ?

Please refer to the Backport tool documentation