[Security Assistant] Fix Knowledge Base API (#211367)

## Summary Fixes bugs related to Security Assistant Knowledge Base API --------- Co-authored-by: kibanamachine <[email protected]> Co-authored-by: Hannah Mudge <[email protected]> Co-authored-by: Marta Bondyra <[email protected]> Co-authored-by: Davis Plumlee <[email protected]> Co-authored-by: Jatin Kathuria <[email protected]> Co-authored-by: Chris Cowan <[email protected]> Co-authored-by: Elastic Machine <[email protected]> Co-authored-by: Arturo Lidueña <[email protected]> Co-authored-by: Jon <[email protected]> Co-authored-by: Rodney Norris <[email protected]> Co-authored-by: Elena Shostak <[email protected]> Co-authored-by: Stratoula Kalafateli <[email protected]> Co-authored-by: Irene Blanco <[email protected]> Co-authored-by: Cauê Marcondes <[email protected]> Co-authored-by: Carlos Crespo <[email protected]> (cherry picked from commit c822109)
elastic · Feb 25, 2025 · 8522d9c · 8522d9c
1 parent d72c24c
commit 8522d9c
Show file tree

Hide file tree

Showing 82 changed files with 1,085 additions and 178 deletions.
diff --git a/oas_docs/output/kibana.serverless.yaml b/oas_docs/output/kibana.serverless.yaml
@@ -37999,7 +37999,7 @@ paths:
         content:
           application/json:
             schema:
-              $ref: '#/components/schemas/Security_AI_Assistant_API_KnowledgeBaseEntryUpdateProps'
+              $ref: '#/components/schemas/Security_AI_Assistant_API_KnowledgeBaseEntryUpdateRouteProps'
         required: true
       responses:
         '200':
@@ -44302,6 +44302,9 @@ components:
       allOf:
         - type: object
           properties:
+            global:
+              description: Whether this Knowledge Base Entry is global, defaults to false
+              type: boolean
             name:
               description: Name of the Knowledge Base Entry
               type: string
@@ -44316,13 +44319,17 @@ components:
           required:
             - name
             - namespace
+            - global
             - users
         - $ref: '#/components/schemas/Security_AI_Assistant_API_ResponseFields'
         - $ref: '#/components/schemas/Security_AI_Assistant_API_DocumentEntryResponseFields'
     Security_AI_Assistant_API_DocumentEntryCreateFields:
       allOf:
         - type: object
           properties:
+            global:
+              description: Whether this Knowledge Base Entry is global, defaults to false
+              type: boolean
             name:
               description: Name of the Knowledge Base Entry
               type: string
@@ -44350,8 +44357,7 @@ components:
       type: object
       properties:
         kbResource:
-          description: Knowledge Base resource name for grouping entries, e.g. 'esql', 'lens-docs', etc
-          type: string
+          $ref: '#/components/schemas/Security_AI_Assistant_API_KnowledgeBaseResource'
         source:
           description: Source document name or filepath
           type: string
@@ -44376,6 +44382,9 @@ components:
       allOf:
         - type: object
           properties:
+            global:
+              description: Whether this Knowledge Base Entry is global, defaults to false
+              type: boolean
             id:
               $ref: '#/components/schemas/Security_AI_Assistant_API_NonEmptyString'
             name:
@@ -44456,6 +44465,9 @@ components:
       allOf:
         - type: object
           properties:
+            global:
+              description: Whether this Knowledge Base Entry is global, defaults to false
+              type: boolean
             name:
               description: Name of the Knowledge Base Entry
               type: string
@@ -44470,13 +44482,17 @@ components:
           required:
             - name
             - namespace
+            - global
             - users
         - $ref: '#/components/schemas/Security_AI_Assistant_API_ResponseFields'
         - $ref: '#/components/schemas/Security_AI_Assistant_API_IndexEntryResponseFields'
     Security_AI_Assistant_API_IndexEntryCreateFields:
       allOf:
         - type: object
           properties:
+            global:
+              description: Whether this Knowledge Base Entry is global, defaults to false
+              type: boolean
             name:
               description: Name of the Knowledge Base Entry
               type: string
@@ -44536,6 +44552,9 @@ components:
       allOf:
         - type: object
           properties:
+            global:
+              description: Whether this Knowledge Base Entry is global, defaults to false
+              type: boolean
             id:
               $ref: '#/components/schemas/Security_AI_Assistant_API_NonEmptyString'
             name:
@@ -44715,6 +44734,18 @@ components:
         - $ref: '#/components/schemas/Security_AI_Assistant_API_IndexEntryUpdateFields'
       discriminator:
         propertyName: type
+    Security_AI_Assistant_API_KnowledgeBaseEntryUpdateRouteProps:
+      anyOf:
+        - $ref: '#/components/schemas/Security_AI_Assistant_API_DocumentEntryCreateFields'
+        - $ref: '#/components/schemas/Security_AI_Assistant_API_IndexEntryCreateFields'
+      discriminator:
+        propertyName: type
+    Security_AI_Assistant_API_KnowledgeBaseResource:
+      description: Knowledge Base resource name for grouping entries, e.g. 'security_labs', 'user', etc
+      enum:
+        - security_labs
+        - user
+      type: string
     Security_AI_Assistant_API_KnowledgeBaseResponse:
       description: AI assistant KnowledgeBase.
       type: object

diff --git a/oas_docs/output/kibana.yaml b/oas_docs/output/kibana.yaml
@@ -40544,7 +40544,7 @@ paths:
         content:
           application/json:
             schema:
-              $ref: '#/components/schemas/Security_AI_Assistant_API_KnowledgeBaseEntryUpdateProps'
+              $ref: '#/components/schemas/Security_AI_Assistant_API_KnowledgeBaseEntryUpdateRouteProps'
         required: true
       responses:
         '200':
@@ -50879,6 +50879,9 @@ components:
       allOf:
         - type: object
           properties:
+            global:
+              description: Whether this Knowledge Base Entry is global, defaults to false
+              type: boolean
             name:
               description: Name of the Knowledge Base Entry
               type: string
@@ -50893,13 +50896,17 @@ components:
           required:
             - name
             - namespace
+            - global
             - users
         - $ref: '#/components/schemas/Security_AI_Assistant_API_ResponseFields'
         - $ref: '#/components/schemas/Security_AI_Assistant_API_DocumentEntryResponseFields'
     Security_AI_Assistant_API_DocumentEntryCreateFields:
       allOf:
         - type: object
           properties:
+            global:
+              description: Whether this Knowledge Base Entry is global, defaults to false
+              type: boolean
             name:
               description: Name of the Knowledge Base Entry
               type: string
@@ -50927,8 +50934,7 @@ components:
       type: object
       properties:
         kbResource:
-          description: Knowledge Base resource name for grouping entries, e.g. 'esql', 'lens-docs', etc
-          type: string
+          $ref: '#/components/schemas/Security_AI_Assistant_API_KnowledgeBaseResource'
         source:
           description: Source document name or filepath
           type: string
@@ -50953,6 +50959,9 @@ components:
       allOf:
         - type: object
           properties:
+            global:
+              description: Whether this Knowledge Base Entry is global, defaults to false
+              type: boolean
             id:
               $ref: '#/components/schemas/Security_AI_Assistant_API_NonEmptyString'
             name:
@@ -51033,6 +51042,9 @@ components:
       allOf:
         - type: object
           properties:
+            global:
+              description: Whether this Knowledge Base Entry is global, defaults to false
+              type: boolean
             name:
               description: Name of the Knowledge Base Entry
               type: string
@@ -51047,13 +51059,17 @@ components:
           required:
             - name
             - namespace
+            - global
             - users
         - $ref: '#/components/schemas/Security_AI_Assistant_API_ResponseFields'
         - $ref: '#/components/schemas/Security_AI_Assistant_API_IndexEntryResponseFields'
     Security_AI_Assistant_API_IndexEntryCreateFields:
       allOf:
         - type: object
           properties:
+            global:
+              description: Whether this Knowledge Base Entry is global, defaults to false
+              type: boolean
             name:
               description: Name of the Knowledge Base Entry
               type: string
@@ -51113,6 +51129,9 @@ components:
       allOf:
         - type: object
           properties:
+            global:
+              description: Whether this Knowledge Base Entry is global, defaults to false
+              type: boolean
             id:
               $ref: '#/components/schemas/Security_AI_Assistant_API_NonEmptyString'
             name:
@@ -51292,6 +51311,18 @@ components:
         - $ref: '#/components/schemas/Security_AI_Assistant_API_IndexEntryUpdateFields'
       discriminator:
         propertyName: type
+    Security_AI_Assistant_API_KnowledgeBaseEntryUpdateRouteProps:
+      anyOf:
+        - $ref: '#/components/schemas/Security_AI_Assistant_API_DocumentEntryCreateFields'
+        - $ref: '#/components/schemas/Security_AI_Assistant_API_IndexEntryCreateFields'
+      discriminator:
+        propertyName: type
+    Security_AI_Assistant_API_KnowledgeBaseResource:
+      description: Knowledge Base resource name for grouping entries, e.g. 'security_labs', 'user', etc
+      enum:
+        - security_labs
+        - user
+      type: string
     Security_AI_Assistant_API_KnowledgeBaseResponse:
       description: AI assistant KnowledgeBase.
       type: object

diff --git a/...ic-assistant-common/docs/openapi/ess/elastic_assistant_api_2023_10_31.bundled.schema.yaml b/...ic-assistant-common/docs/openapi/ess/elastic_assistant_api_2023_10_31.bundled.schema.yaml
@@ -746,7 +746,7 @@ paths:
         content:
           application/json:
             schema:
-              $ref: '#/components/schemas/KnowledgeBaseEntryUpdateProps'
+              $ref: '#/components/schemas/KnowledgeBaseEntryUpdateRouteProps'
         required: true
       responses:
         '200':
@@ -1301,6 +1301,9 @@ components:
       allOf:
         - type: object
           properties:
+            global:
+              description: Whether this Knowledge Base Entry is global, defaults to false
+              type: boolean
             name:
               description: Name of the Knowledge Base Entry
               type: string
@@ -1317,13 +1320,17 @@ components:
           required:
             - name
             - namespace
+            - global
             - users
         - $ref: '#/components/schemas/ResponseFields'
         - $ref: '#/components/schemas/DocumentEntryResponseFields'
     DocumentEntryCreateFields:
       allOf:
         - type: object
           properties:
+            global:
+              description: Whether this Knowledge Base Entry is global, defaults to false
+              type: boolean
             name:
               description: Name of the Knowledge Base Entry
               type: string
@@ -1353,10 +1360,7 @@ components:
       type: object
       properties:
         kbResource:
-          description: >-
-            Knowledge Base resource name for grouping entries, e.g. 'esql',
-            'lens-docs', etc
-          type: string
+          $ref: '#/components/schemas/KnowledgeBaseResource'
         source:
           description: Source document name or filepath
           type: string
@@ -1381,6 +1385,9 @@ components:
       allOf:
         - type: object
           properties:
+            global:
+              description: Whether this Knowledge Base Entry is global, defaults to false
+              type: boolean
             id:
               $ref: '#/components/schemas/NonEmptyString'
             name:
@@ -1463,6 +1470,9 @@ components:
       allOf:
         - type: object
           properties:
+            global:
+              description: Whether this Knowledge Base Entry is global, defaults to false
+              type: boolean
             name:
               description: Name of the Knowledge Base Entry
               type: string
@@ -1479,13 +1489,17 @@ components:
           required:
             - name
             - namespace
+            - global
             - users
         - $ref: '#/components/schemas/ResponseFields'
         - $ref: '#/components/schemas/IndexEntryResponseFields'
     IndexEntryCreateFields:
       allOf:
         - type: object
           properties:
+            global:
+              description: Whether this Knowledge Base Entry is global, defaults to false
+              type: boolean
             name:
               description: Name of the Knowledge Base Entry
               type: string
@@ -1553,6 +1567,9 @@ components:
       allOf:
         - type: object
           properties:
+            global:
+              description: Whether this Knowledge Base Entry is global, defaults to false
+              type: boolean
             id:
               $ref: '#/components/schemas/NonEmptyString'
             name:
@@ -1736,6 +1753,20 @@ components:
         - $ref: '#/components/schemas/IndexEntryUpdateFields'
       discriminator:
         propertyName: type
+    KnowledgeBaseEntryUpdateRouteProps:
+      anyOf:
+        - $ref: '#/components/schemas/DocumentEntryCreateFields'
+        - $ref: '#/components/schemas/IndexEntryCreateFields'
+      discriminator:
+        propertyName: type
+    KnowledgeBaseResource:
+      description: >-
+        Knowledge Base resource name for grouping entries, e.g. 'security_labs',
+        'user', etc
+      enum:
+        - security_labs
+        - user
+      type: string
     KnowledgeBaseResponse:
       description: AI assistant KnowledgeBase.
       type: object