Release refs/heads/master

cognitedata · Jan 16, 2024 · 4e61420 · 4e61420
1 parent 695258c
commit 4e61420
Show file tree

Hide file tree

Showing 168 changed files with 527 additions and 358 deletions.
diff --git a/api/Cognite.Common.ListOrSpaceSeparated.html b/api/Cognite.Common.ListOrSpaceSeparated.html
@@ -11,6 +11,7 @@
       <meta name="title" content="Class ListOrSpaceSeparated
  ">
 
+    <meta name="description" content="A wrapper for yaml types that are serialized either as lists or as space separated values.">
       <link rel="shortcut icon" href="../favicon.ico">
       <link rel="stylesheet" href="../styles/docfx.vendor.min.css">
       <link rel="stylesheet" href="../styles/docfx.css">
@@ -176,7 +177,7 @@ <h5 class="propertyValue">Property Value</h5>
     <tbody>
       <tr>
         <td><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a>[]</td>
-        <td></td>
+        <td>A wrapper for yaml types that are serialized either as lists or as space separated values.</td>
       </tr>
     </tbody>
   </table>
@@ -227,7 +228,7 @@ <h5 class="returns">Returns</h5>
     <tbody>
       <tr>
         <td><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a>[]</td>
-        <td></td>
+        <td>A wrapper for yaml types that are serialized either as lists or as space separated values.</td>
       </tr>
     </tbody>
   </table>

diff --git a/api/Cognite.Common.html b/api/Cognite.Common.html
@@ -11,6 +11,7 @@
       <meta name="title" content="Namespace Cognite.Common
  ">
 
+
       <link rel="shortcut icon" href="../favicon.ico">
       <link rel="stylesheet" href="../styles/docfx.vendor.min.css">
       <link rel="stylesheet" href="../styles/docfx.css">

diff --git a/api/Cognite.Extensions.ApiUtils.html b/api/Cognite.Extensions.ApiUtils.html
@@ -11,6 +11,7 @@
       <meta name="title" content="Class ApiUtils
  ">
 
+    <meta name="description" content="Utility methods for the CogniteSDK.">
       <link rel="shortcut icon" href="../favicon.ico">
       <link rel="stylesheet" href="../styles/docfx.vendor.min.css">
       <link rel="stylesheet" href="../styles/docfx.css">

diff --git a/api/Cognite.Extensions.AssetExtensions.html b/api/Cognite.Extensions.AssetExtensions.html
@@ -11,6 +11,7 @@
       <meta name="title" content="Class AssetExtensions
  ">
 
+    <meta name="description" content="Extension utility methods for CogniteSDK Client.">
       <link rel="shortcut icon" href="../favicon.ico">
       <link rel="stylesheet" href="../styles/docfx.vendor.min.css">
       <link rel="stylesheet" href="../styles/docfx.css">

diff --git a/api/Cognite.Extensions.Authenticator.html b/api/Cognite.Extensions.Authenticator.html
@@ -11,6 +11,7 @@
       <meta name="title" content="Class Authenticator
  ">
 
+    <meta name="description" content="Authenticator that issues a POST request to an authority endpoint defined in the  configuration in order to obtain bearer access tokens. The token is cached and renewed if it expired">
       <link rel="shortcut icon" href="../favicon.ico">
       <link rel="stylesheet" href="../styles/docfx.vendor.min.css">
       <link rel="stylesheet" href="../styles/docfx.css">

diff --git a/api/Cognite.Extensions.AuthenticatorConfig.AuthenticatorImplementation.html b/api/Cognite.Extensions.AuthenticatorConfig.AuthenticatorImplementation.html
@@ -11,6 +11,7 @@
       <meta name="title" content="Enum AuthenticatorConfig.AuthenticatorImplementation
  ">
 
+    <meta name="description" content="DEPRECATED: Available authenticator implementations">
       <link rel="shortcut icon" href="../favicon.ico">
       <link rel="stylesheet" href="../styles/docfx.vendor.min.css">
       <link rel="stylesheet" href="../styles/docfx.css">

diff --git a/api/Cognite.Extensions.AuthenticatorConfig.html b/api/Cognite.Extensions.AuthenticatorConfig.html
@@ -11,6 +11,7 @@
       <meta name="title" content="Class AuthenticatorConfig
  ">
 
+    <meta name="description" content="Authenticator configuration. For more information, read the OAth 2.0 client credentials flow">
       <link rel="shortcut icon" href="../favicon.ico">
       <link rel="stylesheet" href="../styles/docfx.vendor.min.css">
       <link rel="stylesheet" href="../styles/docfx.css">
@@ -205,7 +206,7 @@ <h5 class="propertyValue">Property Value</h5>
     <tbody>
       <tr>
         <td><a class="xref" href="Cognite.Extensions.CertificateConfig.html">CertificateConfig</a></td>
-        <td></td>
+        <td>Authenticator configuration. For more information, read the OAth 2.0 client credentials flow</td>
       </tr>
     </tbody>
   </table>
@@ -268,7 +269,7 @@ <h5 class="propertyValue">Property Value</h5>
     <tbody>
       <tr>
         <td><a class="xref" href="Cognite.Extensions.AuthenticatorConfig.html">AuthenticatorConfig</a>.<a class="xref" href="Cognite.Extensions.AuthenticatorConfig.AuthenticatorImplementation.html">AuthenticatorImplementation</a></td>
-        <td></td>
+        <td>Authenticator configuration. For more information, read the OAth 2.0 client credentials flow</td>
       </tr>
     </tbody>
   </table>

diff --git a/api/Cognite.Extensions.CertificateConfig.html b/api/Cognite.Extensions.CertificateConfig.html
@@ -11,6 +11,7 @@
       <meta name="title" content="Class CertificateConfig
  ">
 
+    <meta name="description" content="Configuration for certificate authentication.">
       <link rel="shortcut icon" href="../favicon.ico">
       <link rel="stylesheet" href="../styles/docfx.vendor.min.css">
       <link rel="stylesheet" href="../styles/docfx.css">
@@ -140,7 +141,7 @@ <h5 class="propertyValue">Property Value</h5>
     <tbody>
       <tr>
         <td><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></td>
-        <td></td>
+        <td>Configuration for certificate authentication.</td>
       </tr>
     </tbody>
   </table>
@@ -171,7 +172,7 @@ <h5 class="propertyValue">Property Value</h5>
     <tbody>
       <tr>
         <td><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></td>
-        <td></td>
+        <td>Configuration for certificate authentication.</td>
       </tr>
     </tbody>
   </table>
@@ -202,7 +203,7 @@ <h5 class="propertyValue">Property Value</h5>
     <tbody>
       <tr>
         <td><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></td>
-        <td></td>
+        <td>Configuration for certificate authentication.</td>
       </tr>
     </tbody>
   </table>

diff --git a/api/Cognite.Extensions.CogniteError-1.html b/api/Cognite.Extensions.CogniteError-1.html
@@ -11,6 +11,7 @@
       <meta name="title" content="Class CogniteError&lt;TError&gt;
  ">
 
+    <meta name="description" content="Represents an error that occured on a push to CDF, or in pre-push sanitation.">
       <link rel="shortcut icon" href="../favicon.ico">
       <link rel="stylesheet" href="../styles/docfx.vendor.min.css">
       <link rel="stylesheet" href="../styles/docfx.css">
@@ -145,7 +146,7 @@ <h5 class="typeParameters">Type Parameters</h5>
     <tbody>
       <tr>
         <td><span class="parametername">TError</span></td>
-        <td></td>
+        <td>Represents an error that occured on a push to CDF, or in pre-push sanitation.</td>
       </tr>
     </tbody>
   </table>
@@ -178,7 +179,7 @@ <h5 class="propertyValue">Property Value</h5>
     <tbody>
       <tr>
         <td><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.collections.generic.ienumerable-1">IEnumerable</a>&lt;TError&gt;</td>
-        <td></td>
+        <td>Represents an error that occured on a push to CDF, or in pre-push sanitation.</td>
       </tr>
     </tbody>
   </table>

diff --git a/api/Cognite.Extensions.CogniteError.html b/api/Cognite.Extensions.CogniteError.html
@@ -11,6 +11,7 @@
       <meta name="title" content="Class CogniteError
  ">
 
+    <meta name="description" content="Represents an error that occured on a push to CDF, or in pre-push sanitation.">
       <link rel="shortcut icon" href="../favicon.ico">
       <link rel="stylesheet" href="../styles/docfx.vendor.min.css">
       <link rel="stylesheet" href="../styles/docfx.css">
@@ -144,7 +145,7 @@ <h5 class="propertyValue">Property Value</h5>
     <tbody>
       <tr>
         <td><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.boolean">bool</a></td>
-        <td></td>
+        <td>Represents an error that occured on a push to CDF, or in pre-push sanitation.</td>
       </tr>
     </tbody>
   </table>
@@ -175,7 +176,7 @@ <h5 class="propertyValue">Property Value</h5>
     <tbody>
       <tr>
         <td><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.exception">Exception</a></td>
-        <td></td>
+        <td>Represents an error that occured on a push to CDF, or in pre-push sanitation.</td>
       </tr>
     </tbody>
   </table>
@@ -206,7 +207,7 @@ <h5 class="propertyValue">Property Value</h5>
     <tbody>
       <tr>
         <td><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></td>
-        <td></td>
+        <td>Represents an error that occured on a push to CDF, or in pre-push sanitation.</td>
       </tr>
     </tbody>
   </table>
@@ -237,7 +238,7 @@ <h5 class="propertyValue">Property Value</h5>
     <tbody>
       <tr>
         <td><a class="xref" href="Cognite.Extensions.ResourceType.html">ResourceType</a></td>
-        <td></td>
+        <td>Represents an error that occured on a push to CDF, or in pre-push sanitation.</td>
       </tr>
     </tbody>
   </table>
@@ -268,7 +269,7 @@ <h5 class="propertyValue">Property Value</h5>
     <tbody>
       <tr>
         <td><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.int32">int</a></td>
-        <td></td>
+        <td>Represents an error that occured on a push to CDF, or in pre-push sanitation.</td>
       </tr>
     </tbody>
   </table>
@@ -300,7 +301,7 @@ <h5 class="propertyValue">Property Value</h5>
     <tbody>
       <tr>
         <td><a class="xref" href="Cognite.Extensions.ErrorType.html">ErrorType</a></td>
-        <td></td>
+        <td>Represents an error that occured on a push to CDF, or in pre-push sanitation.</td>
       </tr>
     </tbody>
   </table>
@@ -331,7 +332,7 @@ <h5 class="propertyValue">Property Value</h5>
     <tbody>
       <tr>
         <td><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.collections.generic.ienumerable-1">IEnumerable</a>&lt;<span class="xref">Identity</span>&gt;</td>
-        <td></td>
+        <td>Represents an error that occured on a push to CDF, or in pre-push sanitation.</td>
       </tr>
     </tbody>
   </table>

diff --git a/api/Cognite.Extensions.CogniteErrorException.html b/api/Cognite.Extensions.CogniteErrorException.html
@@ -11,6 +11,7 @@
       <meta name="title" content="Class CogniteErrorException
  ">
 
+    <meta name="description" content="Exception triggered by a">
       <link rel="shortcut icon" href="../favicon.ico">
       <link rel="stylesheet" href="../styles/docfx.vendor.min.css">
       <link rel="stylesheet" href="../styles/docfx.css">

diff --git a/api/Cognite.Extensions.CogniteExtensions.html b/api/Cognite.Extensions.CogniteExtensions.html
@@ -11,6 +11,7 @@
       <meta name="title" content="Class CogniteExtensions
  ">
 
+    <meta name="description" content="Extension utilities for the Cognite client">
       <link rel="shortcut icon" href="../favicon.ico">
       <link rel="stylesheet" href="../styles/docfx.vendor.min.css">
       <link rel="stylesheet" href="../styles/docfx.css">

diff --git a/api/Cognite.Extensions.CogniteResult-1.html b/api/Cognite.Extensions.CogniteResult-1.html
@@ -11,6 +11,7 @@
       <meta name="title" content="Class CogniteResult&lt;TError&gt;
  ">
 
+    <meta name="description" content="Represents the result of one or more pushes to CDF. Contains a list of errors, one for each failed push, and potentially pre-push santiation.">
       <link rel="shortcut icon" href="../favicon.ico">
       <link rel="stylesheet" href="../styles/docfx.vendor.min.css">
       <link rel="stylesheet" href="../styles/docfx.css">
@@ -124,7 +125,7 @@ <h5 class="typeParameters">Type Parameters</h5>
     <tbody>
       <tr>
         <td><span class="parametername">TError</span></td>
-        <td></td>
+        <td>Represents the result of one or more pushes to CDF. Contains a list of errors, one for each failed push, and potentially pre-push santiation.</td>
       </tr>
     </tbody>
   </table>
@@ -193,7 +194,7 @@ <h5 class="propertyValue">Property Value</h5>
     <tbody>
       <tr>
         <td><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.collections.generic.ienumerable-1">IEnumerable</a>&lt;TError&gt;</td>
-        <td></td>
+        <td>Represents the result of one or more pushes to CDF. Contains a list of errors, one for each failed push, and potentially pre-push santiation.</td>
       </tr>
     </tbody>
   </table>
@@ -224,7 +225,7 @@ <h5 class="propertyValue">Property Value</h5>
     <tbody>
       <tr>
         <td><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.collections.generic.ienumerable-1">IEnumerable</a>&lt;<a class="xref" href="Cognite.Extensions.CogniteError-1.html">CogniteError</a>&lt;TError&gt;&gt;</td>
-        <td></td>
+        <td>Represents the result of one or more pushes to CDF. Contains a list of errors, one for each failed push, and potentially pre-push santiation.</td>
       </tr>
     </tbody>
   </table>
@@ -255,7 +256,7 @@ <h5 class="propertyValue">Property Value</h5>
     <tbody>
       <tr>
         <td><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.boolean">bool</a></td>
-        <td></td>
+        <td>Represents the result of one or more pushes to CDF. Contains a list of errors, one for each failed push, and potentially pre-push santiation.</td>
       </tr>
     </tbody>
   </table>

diff --git a/api/Cognite.Extensions.CogniteResult-2.html b/api/Cognite.Extensions.CogniteResult-2.html
@@ -11,6 +11,7 @@
       <meta name="title" content="Class CogniteResult&lt;TResult, TError&gt;
  ">
 
+    <meta name="description" content="Represents the result of one or more pushes to CDF. Contains a list of errors, one for each failed push, and potentially pre-push santiation, as well as a list of result objects.">
       <link rel="shortcut icon" href="../favicon.ico">
       <link rel="stylesheet" href="../styles/docfx.vendor.min.css">
       <link rel="stylesheet" href="../styles/docfx.css">
@@ -232,7 +233,7 @@ <h5 class="propertyValue">Property Value</h5>
     <tbody>
       <tr>
         <td><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.collections.generic.ienumerable-1">IEnumerable</a>&lt;TResult&gt;</td>
-        <td></td>
+        <td>Represents the result of one or more pushes to CDF. Contains a list of errors, one for each failed push, and potentially pre-push santiation, as well as a list of result objects.</td>
       </tr>
     </tbody>
   </table>

diff --git a/api/Cognite.Extensions.CogniteUtils.html b/api/Cognite.Extensions.CogniteUtils.html
@@ -11,6 +11,7 @@
       <meta name="title" content="Class CogniteUtils
  ">
 
+    <meta name="description" content="Utility class for configuring a Cognite SDK client">
       <link rel="shortcut icon" href="../favicon.ico">
       <link rel="stylesheet" href="../styles/docfx.vendor.min.css">
       <link rel="stylesheet" href="../styles/docfx.css">
@@ -139,7 +140,7 @@ <h5 class="fieldValue">Field Value</h5>
     <tbody>
       <tr>
         <td><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.double">double</a></td>
-        <td></td>
+        <td>Utility class for configuring a Cognite SDK client</td>
       </tr>
     </tbody>
   </table>
@@ -169,7 +170,7 @@ <h5 class="fieldValue">Field Value</h5>
     <tbody>
       <tr>
         <td><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.double">double</a></td>
-        <td></td>
+        <td>Utility class for configuring a Cognite SDK client</td>
       </tr>
     </tbody>
   </table>
@@ -199,7 +200,7 @@ <h5 class="fieldValue">Field Value</h5>
     <tbody>
       <tr>
         <td><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.int32">int</a></td>
-        <td></td>
+        <td>Utility class for configuring a Cognite SDK client</td>
       </tr>
     </tbody>
   </table>
@@ -229,7 +230,7 @@ <h5 class="fieldValue">Field Value</h5>
     <tbody>
       <tr>
         <td><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.int64">long</a></td>
-        <td></td>
+        <td>Utility class for configuring a Cognite SDK client</td>
       </tr>
     </tbody>
   </table>
@@ -259,7 +260,7 @@ <h5 class="fieldValue">Field Value</h5>
     <tbody>
       <tr>
         <td><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.int64">long</a></td>
-        <td></td>
+        <td>Utility class for configuring a Cognite SDK client</td>
       </tr>
     </tbody>
   </table>
@@ -863,7 +864,7 @@ <h5 class="returns">Returns</h5>
     <tbody>
       <tr>
         <td><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.threading.tasks.task">Task</a></td>
-        <td></td>
+        <td>Utility class for configuring a Cognite SDK client</td>
       </tr>
     </tbody>
   </table>
@@ -967,7 +968,7 @@ <h5 class="returns">Returns</h5>
     <tbody>
       <tr>
         <td><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.threading.tasks.task">Task</a></td>
-        <td></td>
+        <td>Utility class for configuring a Cognite SDK client</td>
       </tr>
     </tbody>
   </table>

diff --git a/api/Cognite.Extensions.CogniteUtilsException.html b/api/Cognite.Extensions.CogniteUtilsException.html
@@ -11,6 +11,7 @@
       <meta name="title" content="Class CogniteUtilsException
  ">
 
+    <meta name="description" content="Exceptions produced by the Cognite utility classes">
       <link rel="shortcut icon" href="../favicon.ico">
       <link rel="stylesheet" href="../styles/docfx.vendor.min.css">
       <link rel="stylesheet" href="../styles/docfx.css">

diff --git a/api/Cognite.Extensions.DataModels.AtomicUpdateUtils.html b/api/Cognite.Extensions.DataModels.AtomicUpdateUtils.html
@@ -11,6 +11,7 @@
       <meta name="title" content="Class AtomicUpdateUtils
  ">
 
+    <meta name="description" content="Utility methods for performing atomic updates against FDM.">
       <link rel="shortcut icon" href="../favicon.ico">
       <link rel="stylesheet" href="../styles/docfx.vendor.min.css">
       <link rel="stylesheet" href="../styles/docfx.css">