Quote the labels example, to avoid the YAML interpreter interpretin…

…g it (#782)
elastic · Mar 11, 2020 · 2657c72 · 2657c72
1 parent 142ab78
commit 2657c72
Show file tree

Hide file tree

Showing 7 changed files with 9 additions and 12 deletions.
diff --git a/CHANGELOG.next.md b/CHANGELOG.next.md
@@ -29,6 +29,9 @@ Thanks, you're awesome :-) -->
 
 #### Bugfixes
 
+* Quoted the example for `labels` to avoid YAML interpreting it, and having
+  slightly different results in different situations. #782
+
 #### Added
 
 #### Improvements

diff --git a/docs/field-details.asciidoc b/docs/field-details.asciidoc
@@ -42,7 +42,7 @@ type: object
 
 
 
-example: `{'application': 'foo-bar', 'env': 'production'}`
+example: `{"application": "foo-bar", "env": "production"}`
 
 | core
 

diff --git a/generated/beats/fields.ecs.yml b/generated/beats/fields.ecs.yml
@@ -30,9 +30,7 @@
       All values are stored as keyword.
 
       Example: `docker` and `k8s` labels.'
-    example:
-      application: foo-bar
-      env: production
+    example: '{"application": "foo-bar", "env": "production"}'
   - name: message
     level: core
     type: text

diff --git a/generated/csv/fields.csv b/generated/csv/fields.csv
@@ -1,6 +1,6 @@
 ECS_Version,Indexed,Field_Set,Field,Type,Level,Normalization,Example,Description
 1.6.0-dev,true,base,@timestamp,date,core,,2016-05-23T08:05:34.853Z,Date/time when the event originated.
-1.6.0-dev,true,base,labels,object,core,,"{'application': 'foo-bar', 'env': 'production'}",Custom key/value pairs.
+1.6.0-dev,true,base,labels,object,core,,"{""application"": ""foo-bar"", ""env"": ""production""}",Custom key/value pairs.
 1.6.0-dev,true,base,message,text,core,,Hello World,Log message optimized for viewing in a log viewer.
 1.6.0-dev,true,base,tags,keyword,core,array,"[""production"", ""env2""]",List of keywords used to tag each event.
 1.6.0-dev,true,agent,agent.ephemeral_id,keyword,extended,,8a4f500f,Ephemeral identifier of this agent.

diff --git a/generated/ecs/ecs_flat.yml b/generated/ecs/ecs_flat.yml
@@ -3829,9 +3829,7 @@ labels:
     All values are stored as keyword.
 
     Example: `docker` and `k8s` labels.'
-  example:
-    application: foo-bar
-    env: production
+  example: '{"application": "foo-bar", "env": "production"}'
   flat_name: labels
   level: core
   name: labels

diff --git a/generated/ecs/ecs_nested.yml b/generated/ecs/ecs_nested.yml
@@ -172,9 +172,7 @@ base:
         All values are stored as keyword.
 
         Example: `docker` and `k8s` labels.'
-      example:
-        application: foo-bar
-        env: production
+      example: '{"application": "foo-bar", "env": "production"}'
       flat_name: labels
       level: core
       name: labels

diff --git a/schemas/base.yml b/schemas/base.yml
@@ -39,7 +39,7 @@
       level: core
       type: object
       object_type: keyword
-      example: {application: foo-bar, env: production}
+      example: "{\"application\": \"foo-bar\", \"env\": \"production\"}"
       short: Custom key/value pairs.
       description: >
         Custom key/value pairs.
Original file line number	Diff line number	Diff line change
Expand Up		@@ -42,7 +42,7 @@ type: object



		example: `{'application': 'foo-bar', 'env': 'production'}`
		example: `{"application": "foo-bar", "env": "production"}`

		\| core

Expand Down