github-mirrors/kibana
1
0
Fork 0
mirror of https://github.com/elastic/kibana.git synced 2025-04-24 09:48:58 -04:00
Code Issues Projects Releases Packages Wiki Activity

Improves Security AI Assistant API docs content (#192254)

Browse source 
## Summary

Resolves https://github.com/elastic/security-docs-internal/issues/36 by
improving the Security AI Assistant API docs content. Adds missing and
improves existing operation summaries and operation descriptions to
adhere to our [OAS
standards](450494532/API+reference+docs).

---------

Co-authored-by: kibanamachine <42973632+kibanamachine@users.noreply.github.com>
This commit is contained in:
natasha-moore-elastic 2024-09-06 18:11:47 +01:00 • committed by GitHub
parent d3c3b28c6f
commit 842caa2cbc
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
9 changed files with 62 additions and 58 deletions
Download patch file Download diff file Expand all files Collapse all files

42
x-pack/packages/kbn-elastic-assistant-common/docs/openapi/ess/elastic_assistant_api_2023_10_31.bundled.schema.yaml
View file

@ -14,8 +14,9 @@ paths:
/api/security_ai_assistant/anonymization_fields/_bulk_action:
post:
description: >-
The bulk action is applied to all anonymization fields that match the
filter or to the list of anonymization fields by their IDs.
Apply a bulk action to multiple anonymization fields. The bulk action is
applied to all anonymization fields that match the filter or to the list
of anonymization fields by their IDs.
operationId: PerformAnonymizationFieldsBulkAction
requestBody:
content:
@ -63,13 +64,13 @@ paths:
statusCode:
type: number
description: Generic Error
summary: Applies a bulk action to multiple anonymization fields
summary: Apply a bulk action to anonymization fields
tags:
- Security AI Assistant API
- Bulk API
/api/security_ai_assistant/anonymization_fields/_find:
get:
description: Finds anonymization fields that match the given query.
description: Get a list of all anonymization fields.
operationId: FindAnonymizationFields
parameters:
- in: query
@ -149,13 +150,13 @@ paths:
statusCode:
type: number
description: Generic Error
summary: Finds anonymization fields that match the given query.
summary: Get anonymization fields
tags:
- Security AI Assistant API
- AnonymizationFields API
/api/security_ai_assistant/chat/complete:
post:
description: Creates a model response for the given chat conversation.
description: Create a model response for the given chat conversation.
operationId: ChatComplete
requestBody:
content:
@ -184,13 +185,13 @@ paths:
statusCode:
type: number
description: Generic Error
summary: Creates a model response for the given chat conversation.
summary: Create a model response
tags:
- Security AI Assistant API
- Chat Complete API
/api/security_ai_assistant/current_user/conversations:
post:
description: Create a conversation
description: Create a new Security AI Assistant conversation.
operationId: CreateConversation
requestBody:
content:
@ -224,7 +225,7 @@ paths:
- Conversation API
/api/security_ai_assistant/current_user/conversations/_find:
get:
description: Finds conversations that match the given query.
description: Get a list of all conversations for the current user.
operationId: FindConversations
parameters:
- in: query
@ -304,13 +305,13 @@ paths:
statusCode:
type: number
description: Generic Error
summary: Finds conversations that match the given query.
summary: Get conversations
tags:
- Security AI Assistant API
- Conversations API
'/api/security_ai_assistant/current_user/conversations/{id}':
delete:
description: Deletes a single conversation using the `id` field.
description: Delete an existing conversation using the conversation ID.
operationId: DeleteConversation
parameters:
- description: The conversation's `id` value.
@ -339,12 +340,12 @@ paths:
statusCode:
type: number
description: Generic Error
summary: Deletes a single conversation using the `id` field.
summary: Delete a conversation
tags:
- Security AI Assistant API
- Conversation API
get:
description: Read a single conversation
description: Get the details of an existing conversation using the conversation ID.
operationId: ReadConversation
parameters:
- description: The conversation's `id` value.
@ -373,12 +374,12 @@ paths:
statusCode:
type: number
description: Generic Error
summary: Read a single conversation
summary: Get a conversation
tags:
- Security AI Assistant API
- Conversations API
put:
description: Update a single conversation
description: Update an existing conversation using the conversation ID.
operationId: UpdateConversation
parameters:
- description: The conversation's `id` value.
@ -420,8 +421,9 @@ paths:
/api/security_ai_assistant/prompts/_bulk_action:
post:
description: >-
The bulk action is applied to all prompts that match the filter or to
the list of prompts by their IDs.
Apply a bulk action to multiple prompts. The bulk action is applied to
all prompts that match the filter or to the list of prompts by their
IDs.
operationId: PerformPromptsBulkAction
requestBody:
content:
@ -469,13 +471,13 @@ paths:
statusCode:
type: number
description: Generic Error
summary: Applies a bulk action to multiple prompts
summary: Apply a bulk action to prompts
tags:
- Security AI Assistant API
- Bulk API
/api/security_ai_assistant/prompts/_find:
get:
description: Finds prompts that match the given query.
description: Get a list of all prompts.
operationId: FindPrompts
parameters:
- in: query
@ -555,7 +557,7 @@ paths:
statusCode:
type: number
description: Generic Error
summary: Finds prompts that match the given query.
summary: Get prompts
tags:
- Security AI Assistant API
- Prompts API

42
x-pack/packages/kbn-elastic-assistant-common/docs/openapi/serverless/elastic_assistant_api_2023_10_31.bundled.schema.yaml
View file

@ -14,8 +14,9 @@ paths:
/api/security_ai_assistant/anonymization_fields/_bulk_action:
post:
description: >-
The bulk action is applied to all anonymization fields that match the
filter or to the list of anonymization fields by their IDs.
Apply a bulk action to multiple anonymization fields. The bulk action is
applied to all anonymization fields that match the filter or to the list
of anonymization fields by their IDs.
operationId: PerformAnonymizationFieldsBulkAction
requestBody:
content:
@ -63,13 +64,13 @@ paths:
statusCode:
type: number
description: Generic Error
summary: Applies a bulk action to multiple anonymization fields
summary: Apply a bulk action to anonymization fields
tags:
- Security AI Assistant API
- Bulk API
/api/security_ai_assistant/anonymization_fields/_find:
get:
description: Finds anonymization fields that match the given query.
description: Get a list of all anonymization fields.
operationId: FindAnonymizationFields
parameters:
- in: query
@ -149,13 +150,13 @@ paths:
statusCode:
type: number
description: Generic Error
summary: Finds anonymization fields that match the given query.
summary: Get anonymization fields
tags:
- Security AI Assistant API
- AnonymizationFields API
/api/security_ai_assistant/chat/complete:
post:
description: Creates a model response for the given chat conversation.
description: Create a model response for the given chat conversation.
operationId: ChatComplete
requestBody:
content:
@ -184,13 +185,13 @@ paths:
statusCode:
type: number
description: Generic Error
summary: Creates a model response for the given chat conversation.
summary: Create a model response
tags:
- Security AI Assistant API
- Chat Complete API
/api/security_ai_assistant/current_user/conversations:
post:
description: Create a conversation
description: Create a new Security AI Assistant conversation.
operationId: CreateConversation
requestBody:
content:
@ -224,7 +225,7 @@ paths:
- Conversation API
/api/security_ai_assistant/current_user/conversations/_find:
get:
description: Finds conversations that match the given query.
description: Get a list of all conversations for the current user.
operationId: FindConversations
parameters:
- in: query
@ -304,13 +305,13 @@ paths:
statusCode:
type: number
description: Generic Error
summary: Finds conversations that match the given query.
summary: Get conversations
tags:
- Security AI Assistant API
- Conversations API
'/api/security_ai_assistant/current_user/conversations/{id}':
delete:
description: Deletes a single conversation using the `id` field.
description: Delete an existing conversation using the conversation ID.
operationId: DeleteConversation
parameters:
- description: The conversation's `id` value.
@ -339,12 +340,12 @@ paths:
statusCode:
type: number
description: Generic Error
summary: Deletes a single conversation using the `id` field.
summary: Delete a conversation
tags:
- Security AI Assistant API
- Conversation API
get:
description: Read a single conversation
description: Get the details of an existing conversation using the conversation ID.
operationId: ReadConversation
parameters:
- description: The conversation's `id` value.
@ -373,12 +374,12 @@ paths:
statusCode:
type: number
description: Generic Error
summary: Read a single conversation
summary: Get a conversation
tags:
- Security AI Assistant API
- Conversations API
put:
description: Update a single conversation
description: Update an existing conversation using the conversation ID.
operationId: UpdateConversation
parameters:
- description: The conversation's `id` value.
@ -420,8 +421,9 @@ paths:
/api/security_ai_assistant/prompts/_bulk_action:
post:
description: >-
The bulk action is applied to all prompts that match the filter or to
the list of prompts by their IDs.
Apply a bulk action to multiple prompts. The bulk action is applied to
all prompts that match the filter or to the list of prompts by their
IDs.
operationId: PerformPromptsBulkAction
requestBody:
content:
@ -469,13 +471,13 @@ paths:
statusCode:
type: number
description: Generic Error
summary: Applies a bulk action to multiple prompts
summary: Apply a bulk action to prompts
tags:
- Security AI Assistant API
- Bulk API
/api/security_ai_assistant/prompts/_find:
get:
description: Finds prompts that match the given query.
description: Get a list of all prompts.
operationId: FindPrompts
parameters:
- in: query
@ -555,7 +557,7 @@ paths:
statusCode:
type: number
description: Generic Error
summary: Finds prompts that match the given query.
summary: Get prompts
tags:
- Security AI Assistant API
- Prompts API

4
x-pack/packages/kbn-elastic-assistant-common/impl/schemas/anonymization_fields/bulk_crud_anonymization_fields_route.schema.yaml
View file

@ -8,8 +8,8 @@ paths:
x-codegen-enabled: true
x-labels: [ess, serverless]
operationId: PerformAnonymizationFieldsBulkAction
summary: Applies a bulk action to multiple anonymization fields
description: The bulk action is applied to all anonymization fields that match the filter or to the list of anonymization fields by their IDs.
summary: Apply a bulk action to anonymization fields
description: Apply a bulk action to multiple anonymization fields. The bulk action is applied to all anonymization fields that match the filter or to the list of anonymization fields by their IDs.
tags:
- Bulk API
requestBody:

4
x-pack/packages/kbn-elastic-assistant-common/impl/schemas/anonymization_fields/find_anonymization_fields_route.schema.yaml
View file

@ -8,8 +8,8 @@ paths:
x-codegen-enabled: true
x-labels: [ess, serverless]
operationId: FindAnonymizationFields
description: Finds anonymization fields that match the given query.
summary: Finds anonymization fields that match the given query.
description: Get a list of all anonymization fields.
summary: Get anonymization fields
tags:
- AnonymizationFields API
parameters:

4
x-pack/packages/kbn-elastic-assistant-common/impl/schemas/chat/post_chat_complete_route.schema.yaml
View file

@ -8,8 +8,8 @@ paths:
x-codegen-enabled: true
x-labels: [ess, serverless]
operationId: ChatComplete
description: Creates a model response for the given chat conversation.
summary: Creates a model response for the given chat conversation.
description: Create a model response for the given chat conversation.
summary: Create a model response
tags:
- Chat Complete API
requestBody:

12
x-pack/packages/kbn-elastic-assistant-common/impl/schemas/conversations/crud_conversation_route.schema.yaml
View file

@ -8,7 +8,7 @@ paths:
x-codegen-enabled: true
x-labels: [ess, serverless]
operationId: CreateConversation
description: Create a conversation
description: Create a new Security AI Assistant conversation.
summary: Create a conversation
tags:
- Conversation API
@ -44,8 +44,8 @@ paths:
x-codegen-enabled: true
x-labels: [ess, serverless]
operationId: ReadConversation
description: Read a single conversation
summary: Read a single conversation
description: Get the details of an existing conversation using the conversation ID.
summary: Get a conversation
tags:
- Conversations API
parameters:
@ -79,7 +79,7 @@ paths:
x-codegen-enabled: true
x-labels: [ess, serverless]
operationId: UpdateConversation
description: Update a single conversation
description: Update an existing conversation using the conversation ID.
summary: Update a conversation
tags:
- Conversation API
@ -120,8 +120,8 @@ paths:
x-codegen-enabled: true
x-labels: [ess, serverless]
operationId: DeleteConversation
description: Deletes a single conversation using the `id` field.
summary: Deletes a single conversation using the `id` field.
description: Delete an existing conversation using the conversation ID.
summary: Delete a conversation
tags:
- Conversation API
parameters:

4
x-pack/packages/kbn-elastic-assistant-common/impl/schemas/conversations/find_conversations_route.schema.yaml
View file

@ -8,8 +8,8 @@ paths:
x-codegen-enabled: true
x-labels: [ess, serverless]
operationId: FindConversations
description: Finds conversations that match the given query.
summary: Finds conversations that match the given query.
description: Get a list of all conversations for the current user.
summary: Get conversations
tags:
- Conversations API
parameters:

4
x-pack/packages/kbn-elastic-assistant-common/impl/schemas/prompts/bulk_crud_prompts_route.schema.yaml
View file

@ -8,8 +8,8 @@ paths:
x-codegen-enabled: true
x-labels: [ess, serverless]
operationId: PerformPromptsBulkAction
summary: Applies a bulk action to multiple prompts
description: The bulk action is applied to all prompts that match the filter or to the list of prompts by their IDs.
summary: Apply a bulk action to prompts
description: Apply a bulk action to multiple prompts. The bulk action is applied to all prompts that match the filter or to the list of prompts by their IDs.
tags:
- Bulk API
requestBody:

4
x-pack/packages/kbn-elastic-assistant-common/impl/schemas/prompts/find_prompts_route.schema.yaml
View file

@ -8,8 +8,8 @@ paths:
x-codegen-enabled: true
x-labels: [ess, serverless]
operationId: FindPrompts
description: Finds prompts that match the given query.
summary: Finds prompts that match the given query.
description: Get a list of all prompts.
summary: Get prompts
tags:
- Prompts API
parameters: