github-mirrors/kibana
1
0
Fork 0
mirror of https://github.com/elastic/kibana.git synced 2025-06-27 18:51:07 -04:00
Code Issues Projects Releases Packages Wiki Activity

Improves Entity Analytics API content (#193404)

Browse source 
## Summary

Resolves https://github.com/elastic/security-docs-internal/issues/39 by
improving the Entity Analytics 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-20 11:26:54 +01:00 • committed by GitHub
parent 1e572cfad9
commit d49f7e4a6b
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
10 changed files with 101 additions and 46 deletions
Download patch file Download diff file Expand all files Collapse all files

21
x-pack/test/api_integration/services/security_solution_api.gen.ts
View file

@ -229,8 +229,11 @@ after 30 days. It also deletes other artifacts specific to the migration impleme
.send(props.body as object);
},
/**
* Bulk upsert up to 1000 asset criticality records, creating or updating them as needed.
*/
* Bulk upsert up to 1000 asset criticality records.
If asset criticality records already exist for the specified entities, those records are overwritten with the specified values. If asset criticality records don't exist for the specified entities, new records are created.
*/
bulkUpsertAssetCriticalityRecords(props: BulkUpsertAssetCriticalityRecordsProps) {
return supertest
.post('/api/asset_criticality/bulk')
@ -274,8 +277,11 @@ Migrations are initiated per index. While the process is neither destructive nor
.send(props.body as object);
},
/**
* Create or update a criticality record for a specific asset.
*/
* Create or update an asset criticality record for a specific entity.
If a record already exists for the specified entity, that record is overwritten with the specified value. If a record doesn't exist for the specified entity, a new record is created.
*/
createAssetCriticalityRecord(props: CreateAssetCriticalityRecordProps) {
return supertest
.post('/api/asset_criticality')
@ -324,7 +330,7 @@ Migrations are initiated per index. While the process is neither destructive nor
.set(X_ELASTIC_INTERNAL_ORIGIN_REQUEST, 'kibana');
},
/**
* Delete the asset criticality record for a specific asset if it exists.
* Delete the asset criticality record for a specific entity.
*/
deleteAssetCriticalityRecord(props: DeleteAssetCriticalityRecordProps) {
return supertest
@ -665,7 +671,7 @@ finalize it.
.query(props.query);
},
/**
* Get the criticality record for a specific asset.
* Get the asset criticality record for a specific entity.
*/
getAssetCriticalityRecord(props: GetAssetCriticalityRecordProps) {
return supertest
@ -1064,6 +1070,9 @@ detection engine rules.
.send(props.body as object)
.query(props.query);
},
/**
* Schedule the risk scoring engine to run as soon as possible. You can use this to recalculate entity risk scores after updating their asset criticality.
*/
scheduleRiskEngineNow() {
return supertest
.post('/api/risk_score/engine/schedule_now')