Skip to content
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

Improves Entity Analytics API content #193404

Merged
merged 6 commits into from
Sep 20, 2024
+101 −46
Merged

Improves Entity Analytics API content #193404

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
1075a18
Improves Entity Analytics API content
natasha-moore-elastic Sep 19, 2024
f345bc1
Merge branch 'main' into api-docs-EA-39
natasha-moore-elastic Sep 19, 2024
fe88e67
[CI] Auto-commit changed files from 'yarn openapi:generate'
kibanamachine Sep 19, 2024
43ef867
Merge branch 'main' into api-docs-EA-39
natasha-moore-elastic Sep 19, 2024
3d4803f
Merge branch 'main' into api-docs-EA-39
natasha-moore-elastic Sep 20, 2024
8e18b6d
[CI] Auto-commit changed files from 'yarn openapi:bundle'
kibanamachine Sep 20, 2024
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
7 changes: 5 additions & 2 deletions ...n/common/api/entity_analytics/asset_criticality/bulk_upload_asset_criticality.schema.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,8 +9,11 @@ paths:
x-labels: [ess, serverless]
x-codegen-enabled: true
operationId: BulkUpsertAssetCriticalityRecords
summary: Bulk Upsert Asset Criticality Records
description: Bulk upsert up to 1000 asset criticality records, creating or updating them as needed.
summary: Bulk upsert asset criticality records
description: |
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.
requestBody:
content:
application/json:
Expand Down
7 changes: 5 additions & 2 deletions ...lution/common/api/entity_analytics/asset_criticality/create_asset_criticality.schema.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,8 +9,11 @@ paths:
x-labels: [ess, serverless]
x-codegen-enabled: true
operationId: CreateAssetCriticalityRecord
summary: Upsert Criticality Record
description: Create or update a criticality record for a specific asset.
summary: Upsert an asset criticality record
description: |
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.
requestBody:
required: true
content:
Expand Down
4 changes: 2 additions & 2 deletions ...lution/common/api/entity_analytics/asset_criticality/delete_asset_criticality.schema.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,8 +9,8 @@ paths:
x-labels: [ess, serverless]
x-codegen-enabled: true
operationId: DeleteAssetCriticalityRecord
summary: Delete Criticality Record
description: Delete the asset criticality record for a specific asset if it exists.
summary: Delete an asset criticality record
description: Delete the asset criticality record for a specific entity.
parameters:
- name: id_value
in: query
Expand Down
4 changes: 2 additions & 2 deletions ..._solution/common/api/entity_analytics/asset_criticality/get_asset_criticality.schema.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,8 +9,8 @@ paths:
x-labels: [ess, serverless]
x-codegen-enabled: true
operationId: GetAssetCriticalityRecord
summary: Get Criticality Record
description: Get the criticality record for a specific asset.
summary: Get an asset criticality record
description: Get the asset criticality record for a specific entity.
parameters:
- name: id_value
in: query
Expand Down
2 changes: 1 addition & 1 deletion ...solution/common/api/entity_analytics/asset_criticality/list_asset_criticality.schema.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ paths:
x-labels: [ess, serverless]
x-codegen-enabled: true
operationId: FindAssetCriticalityRecords
summary: List Asset Criticality Records
summary: List asset criticality records
description: List asset criticality records, paging, sorting and filtering as needed.
parameters:
- name: sort_field
Expand Down
3 changes: 2 additions & 1 deletion ...ty_solution/common/api/entity_analytics/risk_engine/engine_schedule_now_route.schema.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,8 @@ paths:
x-labels: [ess, serverless]
x-codegen-enabled: true
operationId: ScheduleRiskEngineNow
summary: Schedule the risk engine to run as soon as possible
summary: Run the risk scoring engine
description: 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.
requestBody:
content:
application/json: {}
Expand Down