Introduction of a short field description to fields and fieldsets (el…

…astic#330) Additional things were fixed, while playing in these descriptions: - Some definitions were adjusted in terms of wording and in terms of separating paragraphs (double \n) - `cloud.provider` examples fixed to mention the actual provider, not a service like "ec2" - Add pointer in `http` field description to `url` - Lowercased the `log.level` examples. The field doesn't technically have the requirement, but at least we can start guiding in that direction for the future.
cpmoore · Feb 22, 2019 · 34b391c · 34b391c
1 parent f2a3f1c
commit 34b391c
Show file tree

Hide file tree

Showing 55 changed files with 567 additions and 267 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -14,9 +14,13 @@ All notable changes to this project will be documented in this file based on the
 * Field set name "group" was being used as a leaf field at `user.group`, instead
  of being a nesting of the field set. This goes against a driving principle of ECS,
  and has been corrected. #308
+* Replaced incorrect examples in `cloud.provider`. #330
 
 ### Added
 
+* Added pointer in description of `http` field set to `url` field set. #330
+* Added an optional short field description. #330
+
 ### Improvements
 * Clarified the definition of the host fields #325
 * Specify the `object_type` for field `labels`. #331

diff --git a/README.md b/README.md
diff --git a/code/go/ecs/agent.go b/code/go/ecs/agent.go
diff --git a/code/go/ecs/base.go b/code/go/ecs/base.go
diff --git a/code/go/ecs/client.go b/code/go/ecs/client.go
diff --git a/code/go/ecs/cloud.go b/code/go/ecs/cloud.go
diff --git a/code/go/ecs/container.go b/code/go/ecs/container.go
diff --git a/code/go/ecs/ecs.go b/code/go/ecs/ecs.go
diff --git a/code/go/ecs/error.go b/code/go/ecs/error.go
diff --git a/code/go/ecs/event.go b/code/go/ecs/event.go
diff --git a/code/go/ecs/file.go b/code/go/ecs/file.go
diff --git a/code/go/ecs/host.go b/code/go/ecs/host.go
diff --git a/code/go/ecs/http.go b/code/go/ecs/http.go
diff --git a/code/go/ecs/log.go b/code/go/ecs/log.go
diff --git a/code/go/ecs/network.go b/code/go/ecs/network.go
diff --git a/code/go/ecs/observer.go b/code/go/ecs/observer.go
diff --git a/code/go/ecs/organization.go b/code/go/ecs/organization.go
diff --git a/code/go/ecs/process.go b/code/go/ecs/process.go
diff --git a/code/go/ecs/related.go b/code/go/ecs/related.go
diff --git a/code/go/ecs/server.go b/code/go/ecs/server.go
diff --git a/code/go/ecs/service.go b/code/go/ecs/service.go