Make all fields linkable directly via an HTML ID (elastic#1148)

webmat · Nov 26, 2020 · 8b415f6 · 8b415f6
1 parent d34f97e
commit 8b415f6
Show file tree

Hide file tree

Showing 8 changed files with 1,643 additions and 416 deletions.
diff --git a/docs/field-details.asciidoc b/docs/field-details.asciidoc
diff --git a/experimental/generated/ecs/ecs_flat.yml b/experimental/generated/ecs/ecs_flat.yml
@@ -1,5 +1,5 @@
 '@timestamp':
-  dashed_name: -timestamp
+  dashed_name: timestamp
   description: 'Date/time when the event originated.
 
     This is the date/time extracted from the event, typically representing when the

diff --git a/experimental/generated/ecs/ecs_nested.yml b/experimental/generated/ecs/ecs_nested.yml
@@ -158,7 +158,7 @@ base:
     events. These fields are common across all types of events.
   fields:
     '@timestamp':
-      dashed_name: -timestamp
+      dashed_name: timestamp
       description: 'Date/time when the event originated.
 
         This is the date/time extracted from the event, typically representing when

diff --git a/generated/ecs/ecs_flat.yml b/generated/ecs/ecs_flat.yml
@@ -1,5 +1,5 @@
 '@timestamp':
-  dashed_name: -timestamp
+  dashed_name: timestamp
   description: 'Date/time when the event originated.
 
     This is the date/time extracted from the event, typically representing when the

diff --git a/generated/ecs/ecs_nested.yml b/generated/ecs/ecs_nested.yml
@@ -160,7 +160,7 @@ base:
     events. These fields are common across all types of events.
   fields:
     '@timestamp':
-      dashed_name: -timestamp
+      dashed_name: timestamp
       description: 'Date/time when the event originated.
 
         This is the date/time extracted from the event, typically representing when

diff --git a/scripts/schema/finalizer.py b/scripts/schema/finalizer.py
@@ -173,7 +173,7 @@ def field_finalizer(details, path):
     name_array = path + [details['field_details']['node_name']]
     flat_name = '.'.join(name_array)
     details['field_details']['flat_name'] = flat_name
-    details['field_details']['dashed_name'] = re.sub('[@_\.]', '-', flat_name)
+    details['field_details']['dashed_name'] = re.sub('[_\.]', '-', flat_name).replace('@', '')
     if 'multi_fields' in details['field_details']:
         for mf in details['field_details']['multi_fields']:
             mf['flat_name'] = flat_name + '.' + mf['name']
diff --git a/scripts/templates/field_details.j2 b/scripts/templates/field_details.j2
@@ -25,7 +25,10 @@ Find additional usage and examples in the {{ fieldset['name'] }} fields <<ecs-{{
 {% if 'original_fieldset' not in field -%}
 
 {# `Field` column -#}
-| {{ field['flat_name'] }}
+|
+[[field-{{field['dashed_name']}}]]
+<<field-{{field['dashed_name']}}, {{ field['flat_name'] }}>>
+
 {# `Description` column -#}
 | {{ field['description']|replace("\n", "\n\n") }}
 

diff --git a/scripts/tests/unit/test_schema_finalizer.py b/scripts/tests/unit/test_schema_finalizer.py
@@ -268,7 +268,7 @@ def test_calculate_final_values(self):
         timestamp_details = base_fields['@timestamp']['field_details']
         self.assertEqual(timestamp_details['flat_name'], '@timestamp',
                          "Field sets with root=true must not namespace field names with the field set's name")
-        self.assertEqual(timestamp_details['dashed_name'], '-timestamp')
+        self.assertEqual(timestamp_details['dashed_name'], 'timestamp')
         # root=false
         self.assertEqual(server_fields['ip']['field_details']['flat_name'], 'server.ip',
                          "Field sets with root=false must namespace field names with the field set's name")
@@ -288,7 +288,7 @@ def test_calculate_final_values(self):
     def test_dashed_name_cleanup(self):
         details = {'field_details': {'node_name': '@time.stamp_'}}
         finalizer.field_finalizer(details, [])
-        self.assertEqual(details['field_details']['dashed_name'], '-time-stamp-')
+        self.assertEqual(details['field_details']['dashed_name'], 'time-stamp-')
 
     # field_group_at_path