Merge pull request #1383 from DataDog/jward/schema-update

Update RUM Event Schema
DataDog · Apr 13, 2023 · d658bdf · d658bdf
2 parents ca81ad7 + 82f1dc4
commit d658bdf
Show file tree

Hide file tree

Showing 3 changed files with 35 additions and 11 deletions.
diff --git a/dd-sdk-android/apiSurface b/dd-sdk-android/apiSurface
@@ -668,7 +668,7 @@ data class com.datadog.android.rum.model.ActionEvent
       fun fromJson(kotlin.String): Application
       fun fromJsonObject(com.google.gson.JsonObject): Application
   data class ActionEventSession
-    constructor(kotlin.String, ActionEventSessionType, kotlin.Boolean? = null, kotlin.Boolean? = true)
+    constructor(kotlin.String, ActionEventSessionType, kotlin.Boolean? = null)
     fun toJson(): com.google.gson.JsonElement
     companion object 
       fun fromJson(kotlin.String): ActionEventSession
@@ -908,7 +908,7 @@ data class com.datadog.android.rum.model.ErrorEvent
       fun fromJson(kotlin.String): Application
       fun fromJsonObject(com.google.gson.JsonObject): Application
   data class ErrorEventSession
-    constructor(kotlin.String, ErrorEventSessionType, kotlin.Boolean? = null, kotlin.Boolean? = true)
+    constructor(kotlin.String, ErrorEventSessionType, kotlin.Boolean? = null)
     fun toJson(): com.google.gson.JsonElement
     companion object 
       fun fromJson(kotlin.String): ErrorEventSession
@@ -1157,7 +1157,7 @@ data class com.datadog.android.rum.model.LongTaskEvent
       fun fromJson(kotlin.String): Application
       fun fromJsonObject(com.google.gson.JsonObject): Application
   data class LongTaskEventSession
-    constructor(kotlin.String, LongTaskEventSessionType, kotlin.Boolean? = null, kotlin.Boolean? = true)
+    constructor(kotlin.String, LongTaskEventSessionType, kotlin.Boolean? = null)
     fun toJson(): com.google.gson.JsonElement
     companion object 
       fun fromJson(kotlin.String): LongTaskEventSession
@@ -1327,7 +1327,7 @@ data class com.datadog.android.rum.model.ResourceEvent
       fun fromJson(kotlin.String): Application
       fun fromJsonObject(com.google.gson.JsonObject): Application
   data class ResourceEventSession
-    constructor(kotlin.String, ResourceEventSessionType, kotlin.Boolean? = null, kotlin.Boolean? = true)
+    constructor(kotlin.String, ResourceEventSessionType, kotlin.Boolean? = null)
     fun toJson(): com.google.gson.JsonElement
     companion object 
       fun fromJson(kotlin.String): ResourceEventSession
@@ -1591,7 +1591,7 @@ data class com.datadog.android.rum.model.ViewEvent
       fun fromJson(kotlin.String): Application
       fun fromJsonObject(com.google.gson.JsonObject): Application
   data class ViewEventSession
-    constructor(kotlin.String, ViewEventSessionType, kotlin.Boolean? = null, kotlin.Boolean? = true)
+    constructor(kotlin.String, ViewEventSessionType, kotlin.Boolean? = null, StartReason? = null, kotlin.Boolean? = true)
     fun toJson(): com.google.gson.JsonElement
     companion object 
       fun fromJson(kotlin.String): ViewEventSession
@@ -1754,6 +1754,16 @@ data class com.datadog.android.rum.model.ViewEvent
     fun toJson(): com.google.gson.JsonElement
     companion object 
       fun fromJson(kotlin.String): ViewEventSessionType
+  enum StartReason
+    constructor(kotlin.String)
+    - APP_START
+    - INACTIVITY_TIMEOUT
+    - MAX_DURATION
+    - STOP_API
+    - BACKGROUND_EVENT
+    fun toJson(): com.google.gson.JsonElement
+    companion object 
+      fun fromJson(kotlin.String): StartReason
   enum LoadingType
     constructor(kotlin.String)
     - INITIAL_LOAD

diff --git a/dd-sdk-android/src/main/json/rum/_common-schema.json b/dd-sdk-android/src/main/json/rum/_common-schema.json
@@ -57,12 +57,6 @@
           "type": "boolean",
           "description": "Whether this session has a replay",
           "readOnly": true
-        },
-        "is_active": {
-          "type": "boolean",
-          "description": "Whether this session is currently active. Set to false to manually stop a session",
-          "default": true,
-          "readOnly": true
         }
       },
       "readOnly": true

diff --git a/dd-sdk-android/src/main/json/rum/view-schema.json b/dd-sdk-android/src/main/json/rum/view-schema.json
@@ -297,6 +297,26 @@
           },
           "readOnly": true
         },
+        "session": {
+          "type": "object",
+          "description": "Session properties",
+          "required": [],
+          "properties": {
+            "start_reason": {
+              "type": "string",
+              "description": "The precondition that led to the creation of the session",
+              "enum": ["app_start", "inactivity_timeout", "max_duration", "stop_api", "background_event"],
+              "readOnly": true
+            },
+            "is_active": {
+              "type": "boolean",
+              "description": "Whether this session is currently active. Set to false to manually stop a session",
+              "default": true,
+              "readOnly": true
+            }
+          },
+          "readOnly": true
+        },
         "feature_flags": {
           "type": "object",
           "description": "Feature flags properties",