docs: document field name conventions for package fields - #1246
Open
roshan13014 wants to merge 2 commits into
Open
docs: document field name conventions for package fields#1246roshan13014 wants to merge 2 commits into
roshan13014 wants to merge 2 commits into
Conversation
|
❌ Author of the following commits did not sign a Contributor Agreement: Please, read and sign the above mentioned agreement if you want to contribute to this project |
teresaromero
reviewed
Sep 9, 2026
| custom fields, follow the same naming conventions used by Beats and | ||
| ECS: | ||
|
|
||
| - Use lowercase letters and snake_case (underscores) to combine words. |
Contributor
There was a problem hiding this comment.
can we just add a referece to the upstream links with the conventions? this way they dont get stale if links are updated
| link: https://github.com/elastic/package-spec/pull/807 | ||
| - description: Document field name conventions (ECS/Beats) on the fields `name` property. | ||
| type: enhancement | ||
| link: https://github.com/elastic/package-spec/issues/426 |
Contributor
There was a problem hiding this comment.
link should be this pr
Suggested change
| link: https://github.com/elastic/package-spec/issues/426 | |
| link: https://github.com/elastic/package-spec/pull/1246 |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Documents Elastic Package field-name conventions on the fields
nameproperty, aligned with Beats and ECS guidance.Fixes #426.
Change
namedescription with ECS preference + Beats/ECS naming rules and linksScope
Docs-only. No validation/pattern changes.
Notes
AI-assisted; reviewed against Beats event-conventions and ECS guidelines.