Skip to content

[9.2] [DOCS] Add missing "required" property in Security APIs (#240921) #243581

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
lcawl merged 2 commits into from
Nov 20, 2025
Merged

[9.2] [DOCS] Add missing "required" property in Security APIs (#240921) #243581

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
9a206a9
[DOCS] Add missing "required" property in Security APIs (#240921)
lcawl Nov 17, 2025
0d7071e
Changes from node scripts/capture_oas_snapshot --include-path /api/…
kibanamachine Nov 20, 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
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -51662,6 +51662,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 @@ -51671,71 +51765,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 @@ -51749,13 +51813,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 @@ -51777,29 +51842,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 @@ -71997,6 +72059,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 @@ -72013,6 +72106,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