chore: cleanup attribution descriptions

aws-observability · Aug 15, 2023 · d5496ff · d5496ff
1 parent 001b143
commit d5496ff
Show file tree

Hide file tree

Showing 3 changed files with 13 additions and 13 deletions.
diff --git a/src/event-schemas/cumulative-layout-shift-event.json b/src/event-schemas/cumulative-layout-shift-event.json
@@ -11,22 +11,22 @@
         },
         "value": {
             "type": "number",
-            "description": "Value of the CLS metric"
+            "description": "Largest burst of unexpected layout shifts during a page's lifespan"
         },
         "attribution": {
             "type": "object",
             "properties": {
                 "largestShiftTarget": {
                     "type": "string",
-                    "description": "Selector identifying first element in the largest layout shift contributing to the CLS score"
+                    "description": "First element in the largest layout shift contributing to CLS score"
                 },
                 "largestShiftValue": {
                     "type": "number",
                     "description": "Value of CLS' single largest shift"
                 },
                 "largestShiftTime": {
                     "type": "number",
-                    "description": "Timestamp of CLS' single largest shift"
+                    "description": "DOMHighResTimeStamp of CLS' single largest shift"
                 },
                 "loadState": {
                     "type": "string",

diff --git a/src/event-schemas/first-input-delay-event.json b/src/event-schemas/first-input-delay-event.json
@@ -11,22 +11,22 @@
         },
         "value": {
             "type": "number",
-            "description": "Value of the fid metric"
+            "description": "Time from first user interaction until the main thread is next idle"
         },
         "attribution": {
             "type": "object",
             "properties": {
                 "eventTarget": {
                     "type": "string",
-                    "description": "A selector identifying the element that the user interacted wit"
+                    "description": "Selector of the element targeted by first user interaction"
                 },
                 "eventType": {
                     "type": "string",
-                    "description": "The type of the event dispatched from the user interaction"
+                    "description": "Type of event dispatched by first user interaction"
                 },
                 "eventTime": {
                     "type": "string",
-                    "description": "Time of user first interaction"
+                    "description": "Timestamp of user first user interaction"
                 },
                 "loadState": {
                     "type": "string",
@@ -36,7 +36,7 @@
                         "dom-content-loaded",
                         "complete"
                     ],
-                    "description": "Loading state of the document"
+                    "description": "LoadState of the document during first user interaction"
                 }
             },
             "additionalProperties": false,

diff --git a/src/event-schemas/largest-contentful-paint-event.json b/src/event-schemas/largest-contentful-paint-event.json
@@ -11,7 +11,7 @@
         },
         "value": {
             "type": "number",
-            "description": "Value of the LCP metric"
+            "description": "Time until the largest element before first user interaction is rendered"
         },
         "attribution": {
             "type": "object",
@@ -22,19 +22,19 @@
                 },
                 "timeToFirstByte": {
                     "type": "number",
-                    "description": "Time until first byte of response"
+                    "description": "Duration until first byte of response"
                 },
                 "resourceLoadDelay": {
                     "type": "number",
-                    "description": "Time after TTFP until LCP resource begins loading"
+                    "description": "Duration after TTFP until LCP resource begins loading"
                 },
                 "resourceLoadTime": {
                     "type": "number",
-                    "description": "Time loading the LCP resource"
+                    "description": "Duration loading the LCP resource"
                 },
                 "elementRenderDelay": {
                     "type": "number",
-                    "description": "Time rendering the LCP resource"
+                    "description": "Duration rendering the LCP resource"
                 }
             },
             "required": [