Skip to content

Commit

Permalink
Provide updated descriptions for user.* field reuses (#1382) (#1384)
Browse files Browse the repository at this point in the history
* provide better short descriptions for user field reuses

* changelog
  • Loading branch information
ebeahan authored Apr 23, 2021
1 parent 3a7be34 commit f8c464d
Show file tree
Hide file tree
Showing 5 changed files with 19 additions and 9 deletions.
1 change: 1 addition & 0 deletions CHANGELOG.next.md
Original file line number Diff line number Diff line change
Expand Up @@ -49,6 +49,7 @@ Thanks, you're awesome :-) -->
* Host metrics fields from RFC 0005 are now GA. #1319
* Adjustments to the field set "usage" docs #1345
* Adjustments to the sidebar naming convention for usage and examples docs #1354
* Update `user.*` field reuse descriptions. #1382

### Tooling and Artifact Changes

Expand Down
6 changes: 3 additions & 3 deletions docs/field-details.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -8260,14 +8260,14 @@ Note also that the `user` fields may be used directly at the root of the events.

| <<ecs-user,user>>
| `user.changes.*`
| Fields to describe the user relevant to the event.
| Captures changes made to a user.

// ===============================================================


| <<ecs-user,user>>
| `user.effective.*`
| Fields to describe the user relevant to the event.
| User whose privileges were assumed.

// ===============================================================

Expand All @@ -8281,7 +8281,7 @@ Note also that the `user` fields may be used directly at the root of the events.

| <<ecs-user,user>>
| `user.target.*`
| Fields to describe the user relevant to the event.
| Targeted user of action taken.

// ===============================================================

Expand Down
9 changes: 6 additions & 3 deletions experimental/generated/ecs/ecs_nested.yml
Original file line number Diff line number Diff line change
Expand Up @@ -15474,26 +15474,29 @@ user:
- as: target
at: user
full: user.target
short_override: Targeted user of action taken.
- as: effective
at: user
full: user.effective
short_override: User whose privileges were assumed.
- as: changes
at: user
full: user.changes
short_override: Captures changes made to a user.
top_level: true
reused_here:
- full: user.group
schema_name: group
short: User's group relevant to the event.
- full: user.target
schema_name: user
short: Fields to describe the user relevant to the event.
short: Targeted user of action taken.
- full: user.effective
schema_name: user
short: Fields to describe the user relevant to the event.
short: User whose privileges were assumed.
- full: user.changes
schema_name: user
short: Fields to describe the user relevant to the event.
short: Captures changes made to a user.
short: Fields to describe the user relevant to the event.
title: User
type: group
Expand Down
9 changes: 6 additions & 3 deletions generated/ecs/ecs_nested.yml
Original file line number Diff line number Diff line change
Expand Up @@ -10950,26 +10950,29 @@ user:
- as: target
at: user
full: user.target
short_override: Targeted user of action taken.
- as: effective
at: user
full: user.effective
short_override: User whose privileges were assumed.
- as: changes
at: user
full: user.changes
short_override: Captures changes made to a user.
top_level: true
reused_here:
- full: user.group
schema_name: group
short: User's group relevant to the event.
- full: user.target
schema_name: user
short: Fields to describe the user relevant to the event.
short: Targeted user of action taken.
- full: user.effective
schema_name: user
short: Fields to describe the user relevant to the event.
short: User whose privileges were assumed.
- full: user.changes
schema_name: user
short: Fields to describe the user relevant to the event.
short: Captures changes made to a user.
short: Fields to describe the user relevant to the event.
title: User
type: group
Expand Down
3 changes: 3 additions & 0 deletions schemas/user.yml
Original file line number Diff line number Diff line change
Expand Up @@ -20,10 +20,13 @@
- source
- at: user
as: target
short_override: Targeted user of action taken.
- at: user
as: effective
short_override: User whose privileges were assumed.
- at: user
as: changes
short_override: Captures changes made to a user.

# TODO Temporarily commented out to simplify initial rewrite review

Expand Down

0 comments on commit f8c464d

Please sign in to comment.