Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
40 commits
Select commit Hold shift + click to select a range
0a823a0
[DOCS] Add missing property in Security APIs
lcawl Oct 28, 2025
207636a
Merge branch 'main' into oas-security
lcawl Oct 28, 2025
f1e1102
Changes from yarn openapi:bundle
kibanamachine Oct 28, 2025
ff4e914
Changes from make api-docs
kibanamachine Oct 28, 2025
81eebdc
Changes from node scripts/capture_oas_snapshot --include-path /api/…
kibanamachine Oct 28, 2025
ff33d32
Changes from yarn openapi:generate
kibanamachine Oct 28, 2025
1ab5709
Merge branch 'main' into oas-security
lcawl Oct 30, 2025
41d5a67
Changes from node scripts/capture_oas_snapshot --include-path /api/…
kibanamachine Oct 30, 2025
c2d736d
Merge branch 'main' into oas-security
lcawl Nov 3, 2025
bf184dc
Merge branch 'main' into oas-security
lcawl Nov 3, 2025
de7331a
Changes from node scripts/capture_oas_snapshot --include-path /api/…
kibanamachine Nov 3, 2025
56fa470
Merge branch 'main' into oas-security
lcawl Nov 4, 2025
20f0e15
Add path variation
lcawl Nov 4, 2025
6f1e030
Add schema references
lcawl Nov 4, 2025
9ba1d47
Changes from node scripts/capture_oas_snapshot --include-path /api/…
kibanamachine Nov 4, 2025
e3fbe7e
Changes from yarn openapi:bundle
kibanamachine Nov 4, 2025
44ae78b
Changes from make api-docs
kibanamachine Nov 4, 2025
84b761a
Remove parameter references for bundling
lcawl Nov 4, 2025
8f19ee3
Generate crud_kb_route.gen.ts
lcawl Nov 4, 2025
711f4ac
Merge branch 'main' into oas-security
lcawl Nov 6, 2025
1822f94
Address CI failure in use_knowledge_base_status.tsx
lcawl Nov 6, 2025
9852ee5
Add examples
lcawl Nov 6, 2025
6f2ad19
Remove refs
lcawl Nov 6, 2025
4666d56
Generate bundle
lcawl Nov 6, 2025
e4c2c22
Merge branch 'main' into oas-security
lcawl Nov 6, 2025
b2110fb
Regenerate Kibana OpenAPI output
lcawl Nov 6, 2025
597b755
Merge branch 'main' into oas-security
lcawl Nov 6, 2025
43a70c0
Changes from node scripts/capture_oas_snapshot --include-path /api/…
kibanamachine Nov 6, 2025
09a814b
Update constants.ts and api.tsx
lcawl Nov 10, 2025
b893303
Merge branch 'main' into oas-security
lcawl Nov 10, 2025
a8604bd
Changes from node scripts/eslint_all_files --no-cache --fix
kibanamachine Nov 10, 2025
4df815e
Address CI error in use_setup_knowledge_base.tsx
lcawl Nov 11, 2025
97919a2
Fix get_kb_resource.test.ts
lcawl Nov 12, 2025
87a823a
Merge branch 'main' into oas-security
lcawl Nov 12, 2025
3982320
Changes from node scripts/capture_oas_snapshot --include-path /api/…
kibanamachine Nov 12, 2025
c37dae6
Clean up types and revert to a single route constant
spong Nov 15, 2025
4093e05
Merge branch 'main' of github.com:elastic/kibana into oas-security
spong Nov 15, 2025
97b34b7
Revert formatting style change
spong Nov 15, 2025
2b4eea0
Merge branch 'main' into oas-security
spong Nov 17, 2025
bf539b8
Merge branch 'main' into oas-security
spong Nov 17, 2025
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
234 changes: 171 additions & 63 deletions oas_docs/output/kibana.serverless.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -53519,6 +53519,100 @@ paths:
x-metaTags:
- content: Kibana, Elastic Cloud Serverless
name: product_name
/api/security_ai_assistant/knowledge_base:
get:
description: |-
**Spaces method and path for this operation:**

<div><span class="operation-verb get">get</span>&nbsp;<span class="operation-path">/s/{space_id}/api/security_ai_assistant/knowledge_base</span></div>

Refer to [Spaces](https://www.elastic.co/docs/deploy-manage/manage-spaces) for more information.

Read a single KB
operationId: GetKnowledgeBase
responses:
'200':
content:
application/json:
examples:
KnowledgeBaseReadResponse200Example2:
summary: A response that returns information about the knowledge base.
value:
defend_insights_exists: true
elser_exists: false
is_setup_available: true
is_setup_in_progress: true
product_documentation_status: installed
security_labs_exists: false
user_data_exists: true
schema:
$ref: '#/components/schemas/Security_AI_Assistant_API_KnowledgeBaseReadResponse200'
description: Indicates a successful call.
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/Security_AI_Assistant_API_KnowledgeBaseResponse400'
description: Generic Error
summary: Read a KnowledgeBase
tags:
- Security AI Assistant API
x-metaTags:
- content: Kibana, Elastic Cloud Serverless
name: product_name
post:
operationId: PostKnowledgeBase
parameters:
- description: ELSER modelId to use when setting up the Knowledge Base. If not provided, a default model will be used.
example: elser-model-001
in: query
name: modelId
required: false
schema:
type: string
- description: Indicates whether we should or should not install Security Labs docs when setting up the Knowledge Base. Defaults to `false`.
example: true
in: query
name: ignoreSecurityLabs
required: false
schema:
default: false
type: boolean
responses:
'200':
content:
application/json:
examples:
KnowledgeBaseResponse200Example2:
summary: A response that indicates that the request was successful.
value:
success: true
schema:
$ref: '#/components/schemas/Security_AI_Assistant_API_KnowledgeBaseResponse'
description: Indicates a successful call.
'400':
content:
application/json:
examples:
KnowledgeBaseResponse400Example2:
summary: A response for a request that failed due to an invalid query parameter value.
value: |
statusCode: 400 error: Bad Request message: "[request query]: ignoreSecurityLabs: Invalid enum value. Expected 'true' | 'false', received 'yes', ignoreSecurityLabs: Expected boolean, received string"
schema:
$ref: '#/components/schemas/Security_AI_Assistant_API_KnowledgeBaseResponse400'
description: Generic Error
summary: Create a KnowledgeBase
tags:
- Security AI Assistant API
x-metaTags:
- content: Kibana, Elastic Cloud Serverless
name: product_name
description: |-
**Spaces method and path for this operation:**

<div><span class="operation-verb post">post</span>&nbsp;<span class="operation-path">/s/{space_id}/api/security_ai_assistant/knowledge_base</span></div>

Refer to [Spaces](https://www.elastic.co/docs/deploy-manage/manage-spaces) for more information.
/api/security_ai_assistant/knowledge_base/{resource}:
get:
description: |-
Expand All @@ -53528,71 +53622,41 @@ paths:

Refer to [Spaces](https://www.elastic.co/docs/deploy-manage/manage-spaces) for more information.

Read a single KB
Read a knowledge base with a specific resource identifier.
operationId: ReadKnowledgeBase
parameters:
- description: The KnowledgeBase `resource` value.
example: kb12345
in: path
name: resource
required: true
schema:
type: string
responses:
'200':
content:
application/json:
schema:
type: object
properties:
defend_insights_exists:
description: Indicates if Defend Insights documentation exists in the KnowledgeBase.
example: true
type: boolean
elser_exists:
description: Indicates if the ELSER model exists for the KnowledgeBase.
example: true
type: boolean
is_setup_available:
description: Indicates if the setup process is available for the KnowledgeBase.
example: true
type: boolean
is_setup_in_progress:
description: Indicates if the setup process is currently in progress.
example: false
type: boolean
product_documentation_status:
description: The status of the product documentation in the KnowledgeBase.
example: complete
type: string
security_labs_exists:
description: Indicates if Security Labs documentation exists in the KnowledgeBase.
example: true
type: boolean
user_data_exists:
description: Indicates if user data exists in the KnowledgeBase.
example: false
type: boolean
examples:
KnowledgeBaseReadResponse200Example1:
summary: A response that returns information about the knowledge base.
value:
defend_insights_exists: true
elser_exists: false
is_setup_available: true
is_setup_in_progress: true
product_documentation_status: installed
security_labs_exists: false
user_data_exists: true
schema:
$ref: '#/components/schemas/Security_AI_Assistant_API_KnowledgeBaseReadResponse200'
description: Indicates a successful call.
'400':
content:
application/json:
schema:
type: object
properties:
error:
description: A short description of the error.
example: Bad Request
type: string
message:
description: A detailed error message.
example: Invalid resource ID provided.
type: string
statusCode:
description: The HTTP status code of the error.
example: 400
type: number
$ref: '#/components/schemas/Security_AI_Assistant_API_KnowledgeBaseResponse400'
description: Generic Error
summary: Read a KnowledgeBase
summary: Read a KnowledgeBase for a resource
tags:
- Security AI Assistant API
x-metaTags:
Expand All @@ -53606,13 +53670,14 @@ paths:

Refer to [Spaces](https://www.elastic.co/docs/deploy-manage/manage-spaces) for more information.

Create a KnowledgeBase
Create a knowledge base with a specific resource identifier.
operationId: CreateKnowledgeBase
parameters:
- description: The KnowledgeBase `resource` value.
example: kb12345
in: path
name: resource
required: true
schema:
type: string
- description: ELSER modelId to use when setting up the Knowledge Base. If not provided, a default model will be used.
Expand All @@ -53634,29 +53699,26 @@ paths:
'200':
content:
application/json:
examples:
KnowledgeBaseResponse200Example1:
summary: A response that indicates that the request was successful.
value:
success: true
schema:
$ref: '#/components/schemas/Security_AI_Assistant_API_KnowledgeBaseResponse'
description: Indicates a successful call.
'400':
content:
application/json:
examples:
KnowledgeBaseResponse400Example1:
summary: A response for a request that failed due to an invalid query parameter value.
value: |
statusCode: 400 error: Bad Request message: "[request query]: ignoreSecurityLabs: Invalid enum value. Expected 'true' | 'false', received 'yes', ignoreSecurityLabs: Expected boolean, received string"
schema:
type: object
properties:
error:
description: A short description of the error.
example: Bad Request
type: string
message:
description: A detailed error message.
example: Invalid resource ID provided.
type: string
statusCode:
description: The HTTP status code of the error.
example: 400
type: number
$ref: '#/components/schemas/Security_AI_Assistant_API_KnowledgeBaseResponse400'
description: Generic Error
summary: Create a KnowledgeBase
summary: Create a KnowledgeBase for a resource
tags:
- Security AI Assistant API
x-metaTags:
Expand Down Expand Up @@ -76907,6 +76969,37 @@ components:
- $ref: '#/components/schemas/Security_AI_Assistant_API_IndexEntryCreateFields'
discriminator:
propertyName: type
Security_AI_Assistant_API_KnowledgeBaseReadResponse200:
type: object
properties:
defend_insights_exists:
description: Indicates if Defend Insights documentation exists in the KnowledgeBase.
example: true
type: boolean
elser_exists:
description: Indicates if the ELSER model exists for the KnowledgeBase.
example: true
type: boolean
is_setup_available:
description: Indicates if the setup process is available for the KnowledgeBase.
example: true
type: boolean
is_setup_in_progress:
description: Indicates if the setup process is currently in progress.
example: false
type: boolean
product_documentation_status:
description: The status of the product documentation in the KnowledgeBase.
example: complete
type: string
security_labs_exists:
description: Indicates if Security Labs documentation exists in the KnowledgeBase.
example: true
type: boolean
user_data_exists:
description: Indicates if user data exists in the KnowledgeBase.
example: false
type: boolean
Security_AI_Assistant_API_KnowledgeBaseResource:
description: Knowledge Base resource name for grouping entries, e.g. 'security_labs', 'user', etc.
enum:
Expand All @@ -76923,6 +77016,21 @@ components:
description: Identify the success of the method execution.
example: true
type: boolean
Security_AI_Assistant_API_KnowledgeBaseResponse400:
type: object
properties:
error:
description: A short description of the error.
example: Bad Request
type: string
message:
description: A detailed error message.
example: Invalid resource ID provided.
type: string
statusCode:
description: The HTTP status code of the error.
example: 400
type: number
Security_AI_Assistant_API_Message:
description: AI assistant conversation message.
type: object
Expand Down
Loading