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

Added examples for necessary Entity Analytics OpenAPI docs #205439

Merged
merged 8 commits into from
Jan 15, 2025
Merged

Added examples for necessary Entity Analytics OpenAPI docs #205439

Show file tree
Hide file tree
Changes from 4 commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
8c0479d
Added examples for necessary Open API docs
jaredburgettelastic Jan 2, 2025
0848f9e
[CI] Auto-commit changed files from 'yarn openapi:bundle'
kibanamachine Jan 2, 2025
f905638
[CI] Auto-commit changed files from 'make api-docs'
kibanamachine Jan 2, 2025
eef7d84
Merge branch 'main' into entity-analytics/api-doc-examples
elasticmachine Jan 13, 2025
d0b6dab
Fixed Asset Criticality ECS properties in OpenAPI examples
jaredburgettelastic Jan 13, 2025
864b21f
[CI] Auto-commit changed files from 'yarn openapi:bundle'
kibanamachine Jan 13, 2025
f9544c3
[CI] Auto-commit changed files from 'make api-docs'
kibanamachine Jan 13, 2025
1966d78
Merge branch 'main' into entity-analytics/api-doc-examples
elasticmachine Jan 15, 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
26 changes: 25 additions & 1 deletion oas_docs/output/kibana.serverless.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4862,6 +4862,7 @@ paths:
operationId: DeleteAssetCriticalityRecord
parameters:
- description: The ID value of the asset.
example: my_host
in: query
name: id_value
required: true
Expand Down Expand Up @@ -4909,6 +4910,7 @@ paths:
operationId: GetAssetCriticalityRecord
parameters:
- description: The ID value of the asset.
example: my_host
in: query
name: id_value
required: true
Expand Down Expand Up @@ -4955,6 +4957,10 @@ paths:
enum:
- wait_for
type: string
example:
criticality_level: high_impact
id_field: host.name
id_value: my_host
required: true
responses:
'200':
Expand Down Expand Up @@ -5080,6 +5086,19 @@ paths:
content:
application/json; Elastic-Api-Version=2023-10-31:
schema:
example:
page: 1
per_page: 10
records:
- '@timestamp': '2024-08-02T14:40:35.705Z'
criticality_level: medium_impact
id_field: host.name
id_value: my_other_host
- '@timestamp': '2024-08-02T11:15:34.290Z'
criticality_level: high_impact
id_field: host.name
id_value: my_host
total: 2
type: object
properties:
page:
Expand All @@ -5101,7 +5120,7 @@ paths:
- page
- per_page
- total
description: Bulk upload successful
description: Successfully retrieved asset criticality records
summary: List asset criticality records
tags:
- Security Entity Analytics API
Expand Down Expand Up @@ -47116,6 +47135,11 @@ components:
type: string
required:
- '@timestamp'
example:
'@timestamp': '2024-08-02T11:15:34.290Z'
criticality_level: high_impact
id_field: host.name
id_value: my_host
Security_Entity_Analytics_API_AssetCriticalityRecordEcsParts:
type: object
properties:
Expand Down
26 changes: 25 additions & 1 deletion oas_docs/output/kibana.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5190,6 +5190,7 @@ paths:
operationId: DeleteAssetCriticalityRecord
parameters:
- description: The ID value of the asset.
example: my_host
in: query
name: id_value
required: true
Expand Down Expand Up @@ -5236,6 +5237,7 @@ paths:
operationId: GetAssetCriticalityRecord
parameters:
- description: The ID value of the asset.
example: my_host
in: query
name: id_value
required: true
Expand Down Expand Up @@ -5281,6 +5283,10 @@ paths:
enum:
- wait_for
type: string
example:
criticality_level: high_impact
id_field: host.name
id_value: my_host
required: true
responses:
'200':
Expand Down Expand Up @@ -5404,6 +5410,19 @@ paths:
content:
application/json; Elastic-Api-Version=2023-10-31:
schema:
example:
page: 1
per_page: 10
records:
- '@timestamp': '2024-08-02T14:40:35.705Z'
criticality_level: medium_impact
id_field: host.name
id_value: my_other_host
- '@timestamp': '2024-08-02T11:15:34.290Z'
criticality_level: high_impact
id_field: host.name
id_value: my_host
total: 2
type: object
properties:
page:
Expand All @@ -5425,7 +5444,7 @@ paths:
- page
- per_page
- total
description: Bulk upload successful
description: Successfully retrieved asset criticality records
summary: List asset criticality records
tags:
- Security Entity Analytics API
Expand Down Expand Up @@ -53991,6 +54010,11 @@ components:
type: string
required:
- '@timestamp'
example:
'@timestamp': '2024-08-02T11:15:34.290Z'
criticality_level: high_impact
id_field: host.name
id_value: my_host
Security_Entity_Analytics_API_AssetCriticalityRecordEcsParts:
type: object
properties:
Expand Down
5 changes: 5 additions & 0 deletions ...lugins/security_solution/common/api/entity_analytics/asset_criticality/common.schema.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -61,6 +61,11 @@ components:
required:
- criticality_level
AssetCriticalityRecord:
example:
id_field: 'host.name'
id_value: my_host
criticality_level: high_impact
'@timestamp': '2024-08-02T11:15:34.290Z'
allOf:
- $ref: '#/components/schemas/CreateAssetCriticalityRecord'
- $ref: '#/components/schemas/AssetCriticalityRecordEcsParts'
Expand Down
4 changes: 4 additions & 0 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 @@ -19,6 +19,10 @@ paths:
content:
application/json:
schema:
example:
id_field: 'host.name'
id_value: 'my_host'
criticality_level: 'high_impact'
allOf:
- $ref: './common.schema.yaml#/components/schemas/CreateAssetCriticalityRecord'
- type: object
Expand Down
1 change: 1 addition & 0 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 @@ -17,6 +17,7 @@ paths:
required: true
schema:
type: string
example: my_host
description: The ID value of the asset.
- name: id_field
in: query
Expand Down
1 change: 1 addition & 0 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 @@ -17,6 +17,7 @@ paths:
required: true
schema:
type: string
example: 'my_host'
description: The ID value of the asset.
- name: id_field
in: query
Expand Down
15 changes: 14 additions & 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 @@ -55,11 +55,24 @@ paths:
description: The kuery to filter by.
responses:
'200':
description: Bulk upload successful
Copy link
Member

Choose a reason for hiding this comment

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

👀

description: Successfully retrieved asset criticality records
content:
application/json:
schema:
type: object
example:
records:
- id_field: 'host.name'
id_value: 'my_other_host'
criticality_level: 'medium_impact'
'@timestamp': '2024-08-02T14:40:35.705Z'
- id_field: 'host.name'
id_value: 'my_host'
criticality_level: 'high_impact'
'@timestamp': '2024-08-02T11:15:34.290Z'
total: 2
page: 1
per_page: 10
properties:
records:
type: array
Expand Down
26 changes: 25 additions & 1 deletion ...on/docs/openapi/ess/security_solution_entity_analytics_api_2023_10_31.bundled.schema.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,7 @@ paths:
operationId: DeleteAssetCriticalityRecord
parameters:
- description: The ID value of the asset.
example: my_host
in: query
name: id_value
required: true
Expand Down Expand Up @@ -65,6 +66,7 @@ paths:
operationId: GetAssetCriticalityRecord
parameters:
- description: The ID value of the asset.
example: my_host
in: query
name: id_value
required: true
Expand Down Expand Up @@ -115,6 +117,10 @@ paths:
enum:
- wait_for
type: string
example:
criticality_level: high_impact
id_field: host.name
id_value: my_host
required: true
responses:
'200':
Expand Down Expand Up @@ -242,6 +248,19 @@ paths:
content:
application/json:
schema:
example:
page: 1
per_page: 10
records:
- '@timestamp': '2024-08-02T14:40:35.705Z'
criticality_level: medium_impact
id_field: host.name
id_value: my_other_host
- '@timestamp': '2024-08-02T11:15:34.290Z'
criticality_level: high_impact
id_field: host.name
id_value: my_host
total: 2
type: object
properties:
page:
Expand All @@ -263,7 +282,7 @@ paths:
- page
- per_page
- total
description: Bulk upload successful
description: Successfully retrieved asset criticality records
summary: List asset criticality records
tags:
- Security Entity Analytics API
Expand Down Expand Up @@ -776,6 +795,11 @@ components:
type: string
required:
- '@timestamp'
example:
'@timestamp': '2024-08-02T11:15:34.290Z'
criticality_level: high_impact
id_field: host.name
id_value: my_host
AssetCriticalityRecordEcsParts:
type: object
properties:
Expand Down
26 changes: 25 additions & 1 deletion .../openapi/serverless/security_solution_entity_analytics_api_2023_10_31.bundled.schema.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,7 @@ paths:
operationId: DeleteAssetCriticalityRecord
parameters:
- description: The ID value of the asset.
example: my_host
in: query
name: id_value
required: true
Expand Down Expand Up @@ -65,6 +66,7 @@ paths:
operationId: GetAssetCriticalityRecord
parameters:
- description: The ID value of the asset.
example: my_host
in: query
name: id_value
required: true
Expand Down Expand Up @@ -115,6 +117,10 @@ paths:
enum:
- wait_for
type: string
example:
criticality_level: high_impact
id_field: host.name
id_value: my_host
required: true
responses:
'200':
Expand Down Expand Up @@ -242,6 +248,19 @@ paths:
content:
application/json:
schema:
example:
page: 1
per_page: 10
records:
- '@timestamp': '2024-08-02T14:40:35.705Z'
criticality_level: medium_impact
id_field: host.name
id_value: my_other_host
- '@timestamp': '2024-08-02T11:15:34.290Z'
criticality_level: high_impact
id_field: host.name
id_value: my_host
total: 2
type: object
properties:
page:
Expand All @@ -263,7 +282,7 @@ paths:
- page
- per_page
- total
description: Bulk upload successful
description: Successfully retrieved asset criticality records
summary: List asset criticality records
tags:
- Security Entity Analytics API
Expand Down Expand Up @@ -776,6 +795,11 @@ components:
type: string
required:
- '@timestamp'
example:
'@timestamp': '2024-08-02T11:15:34.290Z'
criticality_level: high_impact
id_field: host.name
id_value: my_host
AssetCriticalityRecordEcsParts:
type: object
properties:
Expand Down