Documentation

optimizely · mikechu-optimizely · Aug 24, 2022 · Aug 3, 2022 · Aug 3, 2022 · Aug 3, 2022
commit 2d76e3baee78d079be28272b168db74e001ea68c
diff --git a/OptimizelySDK/Odp/Entity/Audience.cs b/OptimizelySDK/Odp/Entity/Audience.cs
@@ -16,8 +16,14 @@
 
 namespace OptimizelySDK.Odp.Entity
 {
+    /// <summary>
+    /// Segment of a customer base
+    /// </summary>
     public class Audience
     {
+        /// <summary>
+        /// Collection of nodes within audience
+        /// </summary>
         public Edge[] Edges { get; set; }
     }
 }
diff --git a/OptimizelySDK/Odp/Entity/Customer.cs b/OptimizelySDK/Odp/Entity/Customer.cs
@@ -16,8 +16,14 @@
 
 namespace OptimizelySDK.Odp.Entity
 {
+    /// <summary>
+    /// Profile used to group/segment an addressable market 
+    /// </summary>
     public class Customer
     {
+        /// <summary>
+        /// Segment of a customer base
+        /// </summary>
         public Audience Audiences { get; set; }
     }
 }
diff --git a/OptimizelySDK/Odp/Entity/Data.cs b/OptimizelySDK/Odp/Entity/Data.cs
@@ -16,8 +16,14 @@
 
 namespace OptimizelySDK.Odp.Entity
 {
+    /// <summary>
+    /// GraphQL response data returned from a valid query
+    /// </summary>
     public class Data
     {
+        /// <summary>
+        /// Grouping of audiences within an overall customer base
+        /// </summary>
         public Customer Customer { get; set; }
     }
 }
diff --git a/OptimizelySDK/Odp/Entity/Edge.cs b/OptimizelySDK/Odp/Entity/Edge.cs
@@ -16,8 +16,14 @@
 
 namespace OptimizelySDK.Odp.Entity
 {
+    /// <summary>
+    /// Grouping of nodes within an audience
+    /// </summary>
     public class Edge
     {
+        /// <summary>
+        /// Atomic portions of a audience
+        /// </summary>
         public Node Node { get; set; }
     }
 }
diff --git a/OptimizelySDK/Odp/Entity/Error.cs b/OptimizelySDK/Odp/Entity/Error.cs
@@ -16,14 +16,29 @@
 
 namespace OptimizelySDK.Odp.Entity
 {
+    /// <summary>
+    /// GraphQL response from an errant query
+    /// </summary>
     public class Error
     {
+        /// <summary>
+        /// Human-readable message from the error
+        /// </summary>
         public string Message { get; set; }
 
+        /// <summary>
+        /// Points of failure producing the error
+        /// </summary>
         public Location[] Locations { get; set; }
 
+        /// <summary>
+        /// Files or urls producing the error
+        /// </summary>
         public string[] Path { get; set; }
 
+        /// <summary>
+        /// Additional technical error information 
+        /// </summary>
         public Extension Extensions { get; set; }
 
         public override string ToString()

diff --git a/OptimizelySDK/Odp/Entity/Extension.cs b/OptimizelySDK/Odp/Entity/Extension.cs
@@ -16,8 +16,14 @@
 
 namespace OptimizelySDK.Odp.Entity
 {
+    /// <summary>
+    /// Extended error information 
+    /// </summary>
     public class Extension
     {
+        /// <summary>
+        /// Named exception type from the error
+        /// </summary>
         public string Classification { get; set; }
     }
 }
diff --git a/OptimizelySDK/Odp/Entity/Location.cs b/OptimizelySDK/Odp/Entity/Location.cs
@@ -16,10 +16,19 @@
 
 namespace OptimizelySDK.Odp.Entity
 {
+    /// <summary>
+    /// Specifies the precise place in code or data where the error occurred
+    /// </summary>
     public class Location
     {
+        /// <summary>
+        /// Code or data line number 
+        /// </summary>
         public int Line { get; set; }
 
+        /// <summary>
+        /// Code or data column number
+        /// </summary>
         public int Column { get; set; }
     }
 }
diff --git a/OptimizelySDK/Odp/Entity/Node.cs b/OptimizelySDK/Odp/Entity/Node.cs
@@ -16,10 +16,19 @@
 
 namespace OptimizelySDK.Odp.Entity
 {
+    /// <summary>
+    /// Atomic grouping an audience
+    /// </summary>
     public class Node
     {
+        /// <summary>
+        /// Descriptive label of a node
+        /// </summary>
         public string Name { get; set; }
 
+        /// <summary>
+  
D0FE
      /// Status of the node
+        /// </summary>
         public string State { get; set; }
     }
 }
diff --git a/OptimizelySDK/Odp/Entity/Response.cs b/OptimizelySDK/Odp/Entity/Response.cs
@@ -16,12 +16,24 @@
 
 namespace OptimizelySDK.Odp.Entity
 {
+    /// <summary>
+    /// Wrapper around valid data and error responses 
+    /// </summary>
     public class Response
     {
+        /// <summary>
+        /// Valid query response information
+        /// </summary>
         public Data Data { get; set; }
 
+        /// <summary>
+        /// Set of errors produced while querying
+        /// </summary>
         public Error[] Errors { get; set; }
 
+        /// <summary>
+        /// Determines if an error exists
+        /// </summary>
         public bool HasErrors
         {
             get