Add a new readme section for reserved top level field sets (#257)

elastic · Dec 10, 2018 · a91e314 · a91e314
1 parent 349406f
commit a91e314
Show file tree

Hide file tree

Showing 3 changed files with 22 additions and 0 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -48,6 +48,8 @@ All notable changes to this project will be documented in this file based on the
 * Improved the definitions for `event.category` and `event.action`. #242
 * Clarify the semantics of `network.direction`. #212
 * Add `source.bytes`, `source.packets`, `destination.bytes` and `destination.packets`. #179
+* Add a readme section to declare some top level field sets are reserved for
+  future use. #257
 
 ### Deprecated
 

diff --git a/README.md b/README.md
@@ -526,6 +526,16 @@ Contributions of additional uses cases on top of ECS are welcome.
 
 
 
+# <a name="reserved-names"></a>Reserved Section Names
+
+ECS does not define the following field sets yet, but the following are expected
+in the future. Please avoid using them:
+
+- `match.*`
+- `protocol.*`
+- `threat.*`
+- `vulnerability.*`
+
 # <a name="implementing-ecs"></a>Implementing ECS
 
 ## Guidelines

diff --git a/docs/implementing.md b/docs/implementing.md
@@ -1,3 +1,13 @@
+# <a name="reserved-names"></a>Reserved Section Names
+
+ECS does not define the following field sets yet, but the following are expected
+in the future. Please avoid using them:
+
+- `match.*`
+- `protocol.*`
+- `threat.*`
+- `vulnerability.*`
+
 # <a name="implementing-ecs"></a>Implementing ECS
 
 ## Guidelines