Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
83 changes: 41 additions & 42 deletions oas_docs/output/kibana.serverless.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -16125,91 +16125,90 @@ paths:
- content: Kibana, Elastic Cloud Serverless
name: product_name
/api/entity_store/entities/{entityType}:
put:
delete:
description: |
Update or create an entity in Entity Store.
If the specified entity already exists, it is updated with the provided values. If the entity does not exist, a new one is created. By default, only the following fields can be updated: * `entity.attributes.*` * `entity.lifecycle.*` * `entity.behavior.*` To update other fields, set the `force` query parameter to `true`. > info > Some fields always retain the first observed value. Updates to these fields will not appear in the final index.
> Due to technical limitations, not all updates are guaranteed to appear in the final list of observed values.
> Due to technical limitations, create is an async operation. The time for a document to be present in the > final index depends on the entity store transform and usually takes more than 1 minute.
operationId: UpsertEntity
Delete a single entity in Entity Store.
The entity will be immediately deleted from the latest index. It will remain available in historical snapshots if it has been snapshotted. The delete operation does not prevent the entity from being recreated if it is observed again in the future.
operationId: DeleteSingleEntity
parameters:
- in: path
name: entityType
required: true
schema:
$ref: '#/components/schemas/Security_Entity_Analytics_API_EntityType'
- in: query
name: force
required: false
schema:
default: false
type: boolean
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/Security_Entity_Analytics_API_Entity'
description: Schema for the updating a single entity
type: object
properties:
id:
description: Identifier of the entity to be deleted, commonly entity.id value.
type: string
required:
- id
description: Schema for the deleting entity
required: true
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/Security_Entity_Analytics_API_Entity'
description: Entity updated or created
'403':
description: Operation on a restricted field
'409':
description: Conflict. The entity was updated while another update was happening in ElasticSearch
type: object
properties:
deleted:
type: boolean
description: Successful response. Entity deleted.
'404':
description: Entity Not Found. No entity with this ID and Type exists.
'503':
description: Operation on an uninitialized Engine or in a cluster without CRUD API Enabled
summary: Upsert an entity in Entity Store
summary: Delete an entity in Entity Store
tags:
- Security Entity Analytics API
x-metaTags:
- content: Kibana, Elastic Cloud Serverless
name: product_name
/api/entity_store/entities/{entityType}/{entityId}:
delete:
put:
description: |
Delete a single entity in Entity Store.
The entity will be immediately deleted from the latest index. It will remain available in historical snapshots if it has been snapshotted. The delete operation does not prevent the entity from being recreated if it is observed again in the future.
operationId: DeleteSingleEntity
Update or create an entity in Entity Store.
If the specified entity already exists, it is updated with the provided values. If the entity does not exist, a new one is created. By default, only the following fields can be updated: * `entity.attributes.*` * `entity.lifecycle.*` * `entity.behavior.*` To update other fields, set the `force` query parameter to `true`. > info > Some fields always retain the first observed value. Updates to these fields will not appear in the final index.
> Due to technical limitations, not all updates are guaranteed to appear in the final list of observed values.
> Due to technical limitations, create is an async operation. The time for a document to be present in the > final index depends on the entity store transform and usually takes more than 1 minute.
operationId: UpsertEntity
parameters:
- in: path
name: entityType
required: true
schema:
$ref: '#/components/schemas/Security_Entity_Analytics_API_EntityType'
- in: query
name: force
required: false
schema:
default: false
type: boolean
requestBody:
content:
application/json:
schema:
type: object
properties:
id:
description: Identifier of the entity to be deleted, commonly entity.id value.
type: string
required:
- id
description: Schema for the deleting entity
$ref: '#/components/schemas/Security_Entity_Analytics_API_Entity'
description: Schema for the updating a single entity
required: true
responses:
'200':
content:
application/json:
schema:
type: object
properties:
deleted:
type: boolean
description: Successful response. Entity deleted.
'404':
description: Entity Not Found. No entity with this ID and Type exists.
$ref: '#/components/schemas/Security_Entity_Analytics_API_Entity'
description: Entity updated or created
'403':
description: Operation on a restricted field
'409':
description: Conflict. The entity was updated while another update was happening in ElasticSearch
'503':
description: Operation on an uninitialized Engine or in a cluster without CRUD API Enabled
summary: Delete an entity in Entity Store
summary: Upsert an entity in Entity Store
tags:
- Security Entity Analytics API
x-metaTags:
Expand Down
87 changes: 43 additions & 44 deletions oas_docs/output/kibana.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -19579,103 +19579,102 @@ paths:

Refer to [Spaces](https://www.elastic.co/docs/deploy-manage/manage-spaces) for more information.
/api/entity_store/entities/{entityType}:
put:
delete:
description: |
**Spaces method and path for this operation:**

<div><span class="operation-verb put">put</span>&nbsp;<span class="operation-path">/s/{space_id}/api/entity_store/entities/{entityType}</span></div>
<div><span class="operation-verb delete">delete</span>&nbsp;<span class="operation-path">/s/{space_id}/api/entity_store/entities/{entityType}</span></div>

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

Update or create an entity in Entity Store.
If the specified entity already exists, it is updated with the provided values. If the entity does not exist, a new one is created. By default, only the following fields can be updated: * `entity.attributes.*` * `entity.lifecycle.*` * `entity.behavior.*` To update other fields, set the `force` query parameter to `true`. > info > Some fields always retain the first observed value. Updates to these fields will not appear in the final index.
> Due to technical limitations, not all updates are guaranteed to appear in the final list of observed values.
> Due to technical limitations, create is an async operation. The time for a document to be present in the > final index depends on the entity store transform and usually takes more than 1 minute.
operationId: UpsertEntity
Delete a single entity in Entity Store.
The entity will be immediately deleted from the latest index. It will remain available in historical snapshots if it has been snapshotted. The delete operation does not prevent the entity from being recreated if it is observed again in the future.
operationId: DeleteSingleEntity
parameters:
- in: path
name: entityType
required: true
schema:
$ref: '#/components/schemas/Security_Entity_Analytics_API_EntityType'
- in: query
name: force
required: false
schema:
default: false
type: boolean
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/Security_Entity_Analytics_API_Entity'
description: Schema for the updating a single entity
type: object
properties:
id:
description: Identifier of the entity to be deleted, commonly entity.id value.
type: string
required:
- id
description: Schema for the deleting entity
required: true
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/Security_Entity_Analytics_API_Entity'
description: Entity updated or created
'403':
description: Operation on a restricted field
'409':
description: Conflict. The entity was updated while another update was happening in ElasticSearch
type: object
properties:
deleted:
type: boolean
description: Successful response. Entity deleted.
'404':
description: Entity Not Found. No entity with this ID and Type exists.
'503':
description: Operation on an uninitialized Engine or in a cluster without CRUD API Enabled
summary: Upsert an entity in Entity Store
summary: Delete an entity in Entity Store
tags:
Comment on lines 19625 to 19627
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

[nit][non-blocking] Was thinking if 409 could also be added here. The server route can return DocumentVersionConflict (409) on delete

- Security Entity Analytics API
x-metaTags:
- content: Kibana
name: product_name
/api/entity_store/entities/{entityType}/{entityId}:
delete:
put:
description: |
**Spaces method and path for this operation:**

<div><span class="operation-verb delete">delete</span>&nbsp;<span class="operation-path">/s/{space_id}/api/entity_store/entities/{entityType}/{entityId}</span></div>
<div><span class="operation-verb put">put</span>&nbsp;<span class="operation-path">/s/{space_id}/api/entity_store/entities/{entityType}</span></div>

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

Delete a single entity in Entity Store.
The entity will be immediately deleted from the latest index. It will remain available in historical snapshots if it has been snapshotted. The delete operation does not prevent the entity from being recreated if it is observed again in the future.
operationId: DeleteSingleEntity
Update or create an entity in Entity Store.
If the specified entity already exists, it is updated with the provided values. If the entity does not exist, a new one is created. By default, only the following fields can be updated: * `entity.attributes.*` * `entity.lifecycle.*` * `entity.behavior.*` To update other fields, set the `force` query parameter to `true`. > info > Some fields always retain the first observed value. Updates to these fields will not appear in the final index.
> Due to technical limitations, not all updates are guaranteed to appear in the final list of observed values.
> Due to technical limitations, create is an async operation. The time for a document to be present in the > final index depends on the entity store transform and usually takes more than 1 minute.
operationId: UpsertEntity
parameters:
- in: path
name: entityType
required: true
schema:
$ref: '#/components/schemas/Security_Entity_Analytics_API_EntityType'
- in: query
name: force
required: false
schema:
default: false
type: boolean
requestBody:
content:
application/json:
schema:
type: object
properties:
id:
description: Identifier of the entity to be deleted, commonly entity.id value.
type: string
required:
- id
description: Schema for the deleting entity
$ref: '#/components/schemas/Security_Entity_Analytics_API_Entity'
description: Schema for the updating a single entity
required: true
responses:
'200':
content:
application/json:
schema:
type: object
properties:
deleted:
type: boolean
description: Successful response. Entity deleted.
'404':
description: Entity Not Found. No entity with this ID and Type exists.
$ref: '#/components/schemas/Security_Entity_Analytics_API_Entity'
description: Entity updated or created
'403':
description: Operation on a restricted field
'409':
description: Conflict. The entity was updated while another update was happening in ElasticSearch
'503':
description: Operation on an uninitialized Engine or in a cluster without CRUD API Enabled
summary: Delete an entity in Entity Store
summary: Upsert an entity in Entity Store
tags:
- Security Entity Analytics API
x-metaTags:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -254,7 +254,7 @@ The entity will be immediately deleted from the latest index. It will remain av
return supertest
.delete(
getRouteUrlForSpace(
replaceParams('/api/entity_store/entities/{entityType}/{entityId}', props.params),
replaceParams('/api/entity_store/entities/{entityType}', props.params),
kibanaSpace
)
)
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ info:
version: '2023-10-31'
title: Entity Store - Delete Single Entity
paths:
/api/entity_store/entities/{entityType}/{entityId}:
/api/entity_store/entities/{entityType}:
delete:
x-labels: [ess, serverless]
x-codegen-enabled: true
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -1085,7 +1085,7 @@ The entity will be immediately deleted from the latest index. It will remain av
this.log.info(`${new Date().toISOString()} Calling API DeleteSingleEntity`);
return this.kbnClient
.request<DeleteSingleEntityResponse>({
path: replaceParams('/api/entity_store/entities/{entityType}/{entityId}', props.params),
path: replaceParams('/api/entity_store/entities/{entityType}', props.params),
headers: {
[ELASTIC_HTTP_VERSION_HEADER]: '2023-10-31',
},
Expand Down
Loading