Made changes in preparation of Release v6.0.5

Updated a few nuget packages. Removed unnecessary code.
jci-metasys · Oct 11, 2024 · 9085094 · 9085094
1 parent b970dcf
commit 9085094
Show file tree

Hide file tree

Showing 108 changed files with 1,391 additions and 1,540 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -5,6 +5,14 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [6.0.5] - 2024-10-11
+### Changed
+- Fixed the issue of trend samples (property names has been changed in the sample object).
+- Fixed issue in the method 'GetObjects()' when it used depths > 1.
+- Made changes to use ActivityId for activities, audits, and alarms.
+- Made changes to use ObjectId for object Ids instead of Guid in ServiceClient.
+- Enabled the use of docfx to generate a static site for the documentation.
+
 ## [6.0.4] - 2024-07-25
 ### Changed
 - Fixed issue related to the method 'GetObjects()' (specifically related to the attribute 'Classification')

diff --git a/MetasysServices.Tests/ActivityIdTests.cs b/MetasysServices.Tests/ActivityIdTests.cs
@@ -1,5 +1,5 @@
-using System;
 using NUnit.Framework;
+using System;
 
 namespace JohnsonControls.Metasys.BasicServices;
 

diff --git a/MetasysServices.Tests/MetasysObjectTests.cs b/MetasysServices.Tests/MetasysObjectTests.cs
@@ -1,7 +1,7 @@
-using System.Linq;
 using Newtonsoft.Json;
 using Newtonsoft.Json.Linq;
 using NUnit.Framework;
+using System.Linq;
 
 namespace JohnsonControls.Metasys.BasicServices;
 

diff --git a/MetasysServices.Tests/MetasysServices.Tests.csproj b/MetasysServices.Tests/MetasysServices.Tests.csproj
@@ -5,7 +5,7 @@
 
     <IsPackable>false</IsPackable>
 
-    <Version>6.0.4</Version>
+    <Version>6.0.5</Version>
 
     <Copyright>© 2020-2024 Johnson Controls</Copyright>
 
@@ -15,12 +15,12 @@
   </PropertyGroup>
 
   <ItemGroup>
-    <PackageReference Include="nunit" Version="3.13.3" />
-    <PackageReference Include="NUnit3TestAdapter" Version="4.3.1">
+    <PackageReference Include="nunit" Version="3.14.0" />
+    <PackageReference Include="NUnit3TestAdapter" Version="4.6.0">
       <PrivateAssets>all</PrivateAssets>
       <IncludeAssets>runtime; build; native; contentfiles; analyzers; buildtransitive</IncludeAssets>
     </PackageReference>
-    <PackageReference Include="Microsoft.NET.Test.Sdk" Version="17.4.1" />
+    <PackageReference Include="Microsoft.NET.Test.Sdk" Version="17.11.1" />
     <PackageReference Include="Nito.AsyncEx" Version="5.1.2" />
   </ItemGroup>
 

diff --git a/MetasysServices.Tests/ObjectIdTests.cs b/MetasysServices.Tests/ObjectIdTests.cs
@@ -1,5 +1,5 @@
-using System;
 using NUnit.Framework;
+using System;
 
 namespace JohnsonControls.Metasys.BasicServices;
 

diff --git a/MetasysServices/Activities/Activity.cs b/MetasysServices/Activities/Activity.cs
@@ -1,8 +1,5 @@
 using Newtonsoft.Json;
 using System;
-using System.Collections.Generic;
-using System.Globalization;
-using System.Linq;
 
 namespace JohnsonControls.Metasys.BasicServices
 {

diff --git a/MetasysServices/Activities/ActivityAlarm.cs b/MetasysServices/Activities/ActivityAlarm.cs
@@ -1,7 +1,4 @@
 using Newtonsoft.Json;
-using System;
-using System.Collections.Generic;
-using System.Text;
 
 namespace JohnsonControls.Metasys.BasicServices
 {

diff --git a/MetasysServices/Activities/ActivityAudit.cs b/MetasysServices/Activities/ActivityAudit.cs
@@ -1,7 +1,4 @@
 using Newtonsoft.Json;
-using System;
-using System.Collections.Generic;
-using System.Text;
 
 namespace JohnsonControls.Metasys.BasicServices
 {

diff --git a/MetasysServices/Activities/ActivityServiceProvider.cs b/MetasysServices/Activities/ActivityServiceProvider.cs
@@ -1,12 +1,7 @@
-using Flurl;
-using Flurl.Http;
-using JohnsonControls.Metasys.BasicServices.Utils;
-using log4net.Config;
-using Newtonsoft.Json;
+using Flurl.Http;
 using Newtonsoft.Json.Linq;
 using System;
 using System.Collections.Generic;
-using System.Globalization;
 using System.Threading.Tasks;
 
 namespace JohnsonControls.Metasys.BasicServices

diff --git a/MetasysServices/Activities/IActivityService.cs b/MetasysServices/Activities/IActivityService.cs
@@ -1,8 +1,4 @@
-using Flurl.Http;
-using System;
-using System.Collections.Generic;
-using System.Globalization;
-using System.Text;
+using System.Collections.Generic;
 using System.Threading.Tasks;
 
 namespace JohnsonControls.Metasys.BasicServices

diff --git a/MetasysServices/Alarms/Alarm.cs b/MetasysServices/Alarms/Alarm.cs
@@ -1,8 +1,4 @@
 using Newtonsoft.Json;
-using System;
-using System.Collections.Generic;
-using System.Globalization;
-using System.Linq;
 
 namespace JohnsonControls.Metasys.BasicServices
 {

diff --git a/MetasysServices/Alarms/AlarmAnnotation.cs b/MetasysServices/Alarms/AlarmAnnotation.cs
@@ -1,5 +1,4 @@
 using Newtonsoft.Json;
-using System;
 
 namespace JohnsonControls.Metasys.BasicServices
 {

diff --git a/MetasysServices/Alarms/AlarmFilter.cs b/MetasysServices/Alarms/AlarmFilter.cs
@@ -1,8 +1,4 @@
-using System;
-using System.Collections.Generic;
-using System.Text;
-
-namespace JohnsonControls.Metasys.BasicServices
+namespace JohnsonControls.Metasys.BasicServices
 {
     /// <summary>
     /// Filters to get alarms when using API v2 or v3.

diff --git a/MetasysServices/Alarms/AlarmFilterV4Plus.cs b/MetasysServices/Alarms/AlarmFilterV4Plus.cs
@@ -1,8 +1,4 @@
-using System;
-using System.Collections.Generic;
-using System.Text;
-
-namespace JohnsonControls.Metasys.BasicServices
+namespace JohnsonControls.Metasys.BasicServices
 {
     /// <summary>
     /// Filters to get activity items from API v4 on.

diff --git a/MetasysServices/Alarms/AlarmServiceProvider.cs b/MetasysServices/Alarms/AlarmServiceProvider.cs
@@ -1,7 +1,6 @@
 using Flurl;
 using Flurl.Http;
 using JohnsonControls.Metasys.BasicServices.Utils;
-using log4net.Config;
 using Newtonsoft.Json;
 using Newtonsoft.Json.Linq;
 using System;

diff --git a/MetasysServices/Alarms/IAlarmService.cs b/MetasysServices/Alarms/IAlarmService.cs
@@ -1,7 +1,5 @@
-using Flurl.Http;
-using System;
+using System;
 using System.Collections.Generic;
-using System.Globalization;
 using System.Threading.Tasks;
 
 namespace JohnsonControls.Metasys.BasicServices

diff --git a/MetasysServices/Audits/Audit.cs b/MetasysServices/Audits/Audit.cs
@@ -1,8 +1,4 @@
 using Newtonsoft.Json;
-using System;
-using System.Collections.Generic;
-using System.Globalization;
-using System.Linq;
 
 namespace JohnsonControls.Metasys.BasicServices
 {

diff --git a/MetasysServices/Audits/AuditAnnotation.cs b/MetasysServices/Audits/AuditAnnotation.cs
@@ -1,7 +1,4 @@
 using Newtonsoft.Json;
-using System;
-using System.Collections.Generic;
-using System.Text;
 
 
 namespace JohnsonControls.Metasys.BasicServices

diff --git a/MetasysServices/Audits/AuditFilter.cs b/MetasysServices/Audits/AuditFilter.cs
@@ -1,8 +1,4 @@
-using System;
-using System.Collections.Generic;
-using System.Text;
-
-namespace JohnsonControls.Metasys.BasicServices
+namespace JohnsonControls.Metasys.BasicServices
 {
     /// <summary>
     /// Filters to get audits

diff --git a/MetasysServices/Audits/AuditServiceProvider.cs b/MetasysServices/Audits/AuditServiceProvider.cs
@@ -3,15 +3,10 @@
 using Newtonsoft.Json;
 using Newtonsoft.Json.Linq;
 using System;
-using System.Collections;
 using System.Collections.Generic;
 using System.ComponentModel;
-using System.Globalization;
 using System.Linq;
-using System.Net;
-using System.Net.Http;
 using System.Reflection;
-using System.Resources;
 using System.Threading.Tasks;
 
 namespace JohnsonControls.Metasys.BasicServices

diff --git a/MetasysServices/Audits/AuditSignature.cs b/MetasysServices/Audits/AuditSignature.cs
@@ -1,8 +1,4 @@
-using System;
-using System.Collections.Generic;
-using System.Text;
-
-namespace JohnsonControls.Metasys.BasicServices
+namespace JohnsonControls.Metasys.BasicServices
 {
     /// <summary>
     /// DTO for the AuditSignature model.

diff --git a/MetasysServices/Audits/IAuditService.cs b/MetasysServices/Audits/IAuditService.cs
@@ -1,7 +1,4 @@
-using Flurl.Http;
-using System;
-using System.Collections.Generic;
-using System.Globalization;
+using System.Collections.Generic;
 using System.Threading.Tasks;
 
 namespace JohnsonControls.Metasys.BasicServices

diff --git a/MetasysServices/Audits/LegacyInfo.cs b/MetasysServices/Audits/LegacyInfo.cs
@@ -1,8 +1,4 @@
-using System;
-using System.Collections.Generic;
-using System.Text;
-
-namespace JohnsonControls.Metasys.BasicServices
+namespace JohnsonControls.Metasys.BasicServices
 {
 
     /// <summary>

diff --git a/MetasysServices/BasicServiceProvider.cs b/MetasysServices/BasicServiceProvider.cs
@@ -1,19 +1,14 @@
 using Flurl;
 using Flurl.Http;
-using JohnsonControls.Metasys.BasicServices;
 using JohnsonControls.Metasys.BasicServices.Utils;
 using Newtonsoft.Json;
 using Newtonsoft.Json.Linq;
 using System;
-using System.Collections;
 using System.Collections.Generic;
-using System.Diagnostics;
 using System.Dynamic;
 using System.Globalization;
 using System.Linq;
 using System.Net;
-using System.Net.Http;
-using System.Resources;
 using System.Threading.Tasks;
 
 namespace JohnsonControls.Metasys.BasicServices
@@ -174,12 +169,12 @@ protected List<NetworkDevice> ToNetworkDevice(List<JToken> items, ApiVersion ver
         /// <param name="id"></param>
         /// <param name="parameters"></param>
         /// <returns></returns>
-        /// <exception cref="InvalidOperationException">If <see cref="Vers"/> is less than <see cref="ApiVersion.v4"/></exception>
+        /// <exception cref="InvalidOperationException">If <see cref="Version"/> is less than <see cref="ApiVersion.v4"/></exception>
         /// <returns>
         /// If <paramref name="id"/> is specified then this method returns the children of the specified object (and any of their children if level > 1).
         /// If <c>id</c> is <c>null</c> then this method returns the root object (and it's children; unless level is 0).
         /// </returns>
-        protected async Task<List<MetasysObject>> GetObjectsAsync(Guid? id, Dictionary<string, string> parameters = null)
+        protected async Task<List<MetasysObject>> GetObjectsAsync(ObjectId? id, Dictionary<string, string> parameters = null)
         {
             if (Version <= ApiVersion.v3)
             {
@@ -215,7 +210,7 @@ protected async Task<List<MetasysObject>> GetObjectsAsync(Guid? id, Dictionary<s
         /// <param name="levels">The number of levels to retrieve children.</param>
         /// <exception cref="MetasysHttpException"></exception>
         /// <exception cref="MetasysHttpParsingException"></exception>
-        protected async Task<List<TreeObject>> GetObjectChildrenAsync(Object id, Dictionary<string, string> parameters = null, int levels = 1)
+        protected async Task<List<TreeObject>> GetObjectChildrenAsync(ObjectId id, Dictionary<string, string> parameters = null, int levels = 1)
         {
             if (Version > ApiVersion.v3)
             {
@@ -698,8 +693,7 @@ public static Dictionary<string, string> ToDictionary(object obj)
             var json = JsonConvert.SerializeObject(obj);
             var dictionary = JsonConvert.DeserializeObject<Dictionary<string, string>>(json);
             // Check and in case removes some items not allowed for a specific request
-            String activityType;
-            if (dictionary.TryGetValue("ActivityType", out activityType))
+            if (dictionary.TryGetValue("ActivityType", out string activityType))
             {
                 if (activityType == "audit")
                 {
@@ -771,7 +765,7 @@ protected async Task<JToken> PostBatchRequestAsync(string endpoint, IEnumerable<
             // Concatenate batch segment to use batch request and prepare the list of requests
             foreach (var r in requests)
             {
-                Url relativeUrl = new Url(r.ObjectId.ToString());
+                Url relativeUrl = new(r.ObjectId.ToString());
                 relativeUrl.AppendPathSegments(paths); // e.g. "00000000-0000-0000-0000-000000000001/annotations"
 
                 object body;

diff --git a/MetasysServices/Enumerations/EnumerationServiceProvider.cs b/MetasysServices/Enumerations/EnumerationServiceProvider.cs
@@ -1,17 +1,11 @@
 using Flurl;
 using Flurl.Http;
-using JohnsonControls.Metasys.BasicServices.Utils;
-using log4net.Config;
 using Newtonsoft.Json;
 using Newtonsoft.Json.Linq;
 using System;
-using System.Collections;
 using System.Collections.Generic;
 using System.Dynamic;
-using System.Globalization;
 using System.Linq;
-using System.Net;
-using System.Net.Http;
 using System.Threading.Tasks;
 
 

diff --git a/MetasysServices/Enumerations/IEnumerationService.cs b/MetasysServices/Enumerations/IEnumerationService.cs
@@ -1,7 +1,5 @@
-using JohnsonControls.Metasys.BasicServices;
-using System;
+using System;
 using System.Collections.Generic;
-using System.Globalization;
 using System.Threading.Tasks;
 
 namespace JohnsonControls.Metasys.BasicServices

diff --git a/MetasysServices/Enums/ActionTypeEnum .cs b/MetasysServices/Enums/ActionTypeEnum .cs
@@ -1,7 +1,5 @@
 using System;
-using System.Collections.Generic;
 using System.ComponentModel;
-using System.Text;
 
 namespace JohnsonControls.Metasys.BasicServices
 {

diff --git a/MetasysServices/Enums/ActivityManagementStatusEnum.cs b/MetasysServices/Enums/ActivityManagementStatusEnum.cs
@@ -1,7 +1,4 @@
-using System;
-using System.Collections.Generic;
-using System.ComponentModel;
-using System.Text;
+using System.ComponentModel;
 
 namespace JohnsonControls.Metasys.BasicServices
 {

diff --git a/MetasysServices/Enums/AttributeEnumSet.cs b/MetasysServices/Enums/AttributeEnumSet.cs
@@ -1,9 +1,4 @@
-using System;
-using System.Collections.Generic;
-using System.ComponentModel;
-using System.Text;
-
-namespace JohnsonControls.Metasys.BasicServices
+namespace JohnsonControls.Metasys.BasicServices
 {
     /// <summary>
     /// Enumeration of possible Attributes (typically for Trended Samples).

diff --git a/MetasysServices/Enums/ClassLevelsEnum.cs b/MetasysServices/Enums/ClassLevelsEnum.cs
@@ -1,7 +1,5 @@
 using System;
-using System.Collections.Generic;
 using System.ComponentModel;
-using System.Text;
 
 namespace JohnsonControls.Metasys.BasicServices
 {

diff --git a/MetasysServices/Enums/MetasysObjectTypeEnum.cs b/MetasysServices/Enums/MetasysObjectTypeEnum.cs
@@ -1,8 +1,4 @@
-using System;
-using System.Collections.Generic;
-using System.Text;
-
-namespace JohnsonControls.Metasys.BasicServices
+namespace JohnsonControls.Metasys.BasicServices
 {
     /// <summary>
     /// Collection of Metasys Object Types.

diff --git a/MetasysServices/Enums/NetworkDeviceClassificationEnum.cs b/MetasysServices/Enums/NetworkDeviceClassificationEnum.cs
@@ -1,8 +1,4 @@
-using System;
-using System.Collections.Generic;
-using System.Text;
-
-namespace JohnsonControls.Metasys.BasicServices.Enums
+namespace JohnsonControls.Metasys.BasicServices.Enums
 {
     /// <summary>
     /// Network Devices Classification Enumeration.

diff --git a/MetasysServices/Enums/NetworkDeviceTypeEnum.cs b/MetasysServices/Enums/NetworkDeviceTypeEnum.cs
@@ -1,8 +1,4 @@
-using System;
-using System.Collections.Generic;
-using System.Text;
-
-namespace JohnsonControls.Metasys.BasicServices
+namespace JohnsonControls.Metasys.BasicServices
 {
     /// <summary>
     /// Enumeration of possible Network Device Type.

diff --git a/MetasysServices/Enums/OriginApplicationsEnum.cs b/MetasysServices/Enums/OriginApplicationsEnum.cs
@@ -1,7 +1,5 @@
 using System;
-using System.Collections.Generic;
 using System.ComponentModel;
-using System.Text;
 
 namespace JohnsonControls.Metasys.BasicServices
 {