Skip to content

Commit 5d9cdf7

Browse files
committed
language updates
1 parent 7bd66aa commit 5d9cdf7

File tree

4 files changed

+14
-20
lines changed

4 files changed

+14
-20
lines changed

x-pack/solutions/security/plugins/security_solution/common/api/detection_engine/model/rule_schema/common_attributes.gen.ts

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -90,19 +90,19 @@ export type IsExternalRuleCustomized = z.infer<typeof IsExternalRuleCustomized>;
9090
export const IsExternalRuleCustomized = z.boolean();
9191

9292
/**
93-
* Determines whether or not an external/prebuilt rule has its original, unmodified version present when the `is_customized` calculation is performed.
93+
* Determines whether an external/prebuilt rule has its original, unmodified version present when the `is_customized` calculation is performed.
9494
*/
9595
export type ExternalRuleHasBaseVersion = z.infer<typeof ExternalRuleHasBaseVersion>;
9696
export const ExternalRuleHasBaseVersion = z.boolean();
9797

9898
/**
99-
* An array of field names that have been customized by the user (i.e. any of its fields that have been modified and have diverged from the base value). Defaults to an empty array.
99+
* An array of customized field namesthat is, fields that the user has modified from their base value. Defaults to an empty array.
100100
*/
101101
export type ExternalRuleCustomizedFields = z.infer<typeof ExternalRuleCustomizedFields>;
102102
export const ExternalRuleCustomizedFields = z.array(
103103
z.object({
104104
/**
105-
* Name of the field in the rule object that has been customized from its base value by the user.
105+
* Name of a user-modified field in the rule object.
106106
*/
107107
field_name: z.string(),
108108
})

x-pack/solutions/security/plugins/security_solution/common/api/detection_engine/model/rule_schema/common_attributes.schema.yaml

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -72,7 +72,7 @@ components:
7272

7373
ExternalRuleHasBaseVersion:
7474
type: boolean
75-
description: Determines whether or not an external/prebuilt rule has its original, unmodified version present when the `is_customized` calculation is performed.
75+
description: Determines whether an external/prebuilt rule has its original, unmodified version present when the `is_customized` calculation is performed.
7676

7777
ExternalRuleCustomizedFields:
7878
type: array
@@ -81,11 +81,11 @@ components:
8181
properties:
8282
field_name:
8383
type: string
84-
description: Name of the field in the rule object that has been customized from its base value by the user.
84+
description: Name of a user-modified field in the rule object.
8585
required:
8686
- field_name
8787

88-
description: An array of field names that have been customized by the user (i.e. any of its fields that have been modified and have diverged from the base value). Defaults to an empty array.
88+
description: An array of customized field namesthat is, fields that the user has modified from their base value. Defaults to an empty array.
8989

9090
InternalRuleSource:
9191
description: Type of rule source for internally sourced rules, i.e. created within the Kibana apps.

x-pack/solutions/security/plugins/security_solution/docs/openapi/ess/security_solution_detections_api_2023_10_31.bundled.schema.yaml

Lines changed: 4 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -6275,23 +6275,20 @@ components:
62756275
type: string
62766276
ExternalRuleCustomizedFields:
62776277
description: >-
6278-
An array of field names that have been customized by the user (i.e. any
6279-
of its fields that have been modified and have diverged from the base
6280-
value). Defaults to an empty array.
6278+
An array of customized field names—that is, fields that the user has
6279+
modified from their base value. Defaults to an empty array.
62816280
items:
62826281
type: object
62836282
properties:
62846283
field_name:
6285-
description: >-
6286-
Name of the field in the rule object that has been customized from
6287-
its base value by the user.
6284+
description: Name of a user-modified field in the rule object.
62886285
type: string
62896286
required:
62906287
- field_name
62916288
type: array
62926289
ExternalRuleHasBaseVersion:
62936290
description: >-
6294-
Determines whether or not an external/prebuilt rule has its original,
6291+
Determines whether an external/prebuilt rule has its original,
62956292
unmodified version present when the `is_customized` calculation is
62966293
performed.
62976294
type: boolean

x-pack/solutions/security/plugins/security_solution/docs/openapi/serverless/security_solution_detections_api_2023_10_31.bundled.schema.yaml

Lines changed: 4 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -5605,23 +5605,20 @@ components:
56055605
type: string
56065606
ExternalRuleCustomizedFields:
56075607
description: >-
5608-
An array of field names that have been customized by the user (i.e. any
5609-
of its fields that have been modified and have diverged from the base
5610-
value). Defaults to an empty array.
5608+
An array of customized field names—that is, fields that the user has
5609+
modified from their base value. Defaults to an empty array.
56115610
items:
56125611
type: object
56135612
properties:
56145613
field_name:
5615-
description: >-
5616-
Name of the field in the rule object that has been customized from
5617-
its base value by the user.
5614+
description: Name of a user-modified field in the rule object.
56185615
type: string
56195616
required:
56205617
- field_name
56215618
type: array
56225619
ExternalRuleHasBaseVersion:
56235620
description: >-
5624-
Determines whether or not an external/prebuilt rule has its original,
5621+
Determines whether an external/prebuilt rule has its original,
56255622
unmodified version present when the `is_customized` calculation is
56265623
performed.
56275624
type: boolean

0 commit comments

Comments
 (0)