Removed unavalable fields from IADSInstance and made Fitness optional

Author: p0t4t0sandwich

TypeSpec.json

@@ -1482,21 +1482,11 @@
                 "Name": "Disabled",
                 "TypeName": "Boolean"
             },
-            {
-                "Description": "The fitness information object",
-                "Name": "Fitness",
-                "TypeName": "ProvisionFitness"
-            },
             {
                 "Description": "The friendly name",
                 "Name": "FriendlyName",
                 "TypeName": "String"
             },
-            {
-                "Description": "The host",
-                "Name": "Host",
-                "TypeName": "String"
-            },
             {
                 "Description": "The ID",
                 "Name": "Id",
@@ -1507,16 +1497,6 @@
                 "Name": "InstanceId",
                 "TypeName": "Guid"
             },
-            {
-                "Description": "The instances",
-                "Name": "Instances",
-                "TypeName": "List<InstanceSummary>"
-            },
-            {
-                "Description": "Whether HTTPS is enabled",
-                "Name": "IsHTTPS",
-                "TypeName": "Boolean"
-            },
             {
                 "Description": "Whether the instance is remote",
                 "Name": "IsRemote",
@@ -1532,11 +1512,6 @@
                 "Name": "Platform",
                 "TypeName": "IPlatformInfo"
             },
-            {
-                "Description": "The port",
-                "Name": "Port",
-                "TypeName": "Int32"
-            },
             {
                 "Description": "The state",
                 "Name": "State",
@@ -1561,6 +1536,12 @@
                 "Description": "The URL",
                 "Name": "URL",
                 "TypeName": "String"
+            },
+            {
+                "Description": "The fitness information object",
+                "Name": "Fitness",
+                "TypeName": "ProvisionFitness",
+                "Optional": true
             }
         ]
     },

libraries/python/README.md

@@ -58,7 +58,7 @@ def main():
     # API call parameters are simply in the same order as shown in the documentation.
     API.Core.SendConsoleMessage("say Hello Everyone, this message was sent from the Python API!")
 
-    currentStatus: Status = API.Core.GetStatus()
+    currentStatus: StatusResponse = API.Core.GetStatus()
     cpuUsage: MetricInfo = currentStatus.Metrics.get("CPU Usage")
 
     print(f"Current CPU usage is: {cpuUsage.Percent}%")
@@ -88,15 +88,15 @@ async def main():
     # API call parameters are simply in the same order as shown in the documentation.
     await API.Core.SendConsoleMessage("say Hello Everyone, this message was sent from the Python API!")
 
-    currentStatus: Status = await API.Core.GetStatus()
+    currentStatus: StatusResponse = await API.Core.GetStatus()
     cpuUsage: MetricInfo = currentStatus.Metrics.get("CPU Usage")
 
     print(f"Current CPU usage is: {cpuUsage.Percent}%")
 
 asyncio.run(main())
 ```
 
-** THE BELOW EXAMPLES ARE OUTDATED **
+**THE BELOW EXAMPLES ARE OUTDATED**
 
 ### Example using the ADS to manage an instance
 

libraries/python/ampapi/types.py

@@ -903,28 +903,18 @@ class IADSInstance:
     :type Description: str
     :param Disabled: Whether the instance is disabled
     :type Disabled: bool
-    :param Fitness: The fitness information object
-    :type Fitness: ProvisionFitness
     :param FriendlyName: The friendly name
     :type FriendlyName: str
-    :param Host: The host
-    :type Host: str
     :param Id: The ID
     :type Id: int
     :param InstanceId: The instance ID
     :type InstanceId: str
-    :param Instances: The instances
-    :type Instances: list[InstanceSummary]
-    :param IsHTTPS: Whether HTTPS is enabled
-    :type IsHTTPS: bool
     :param IsRemote: Whether the instance is remote
     :type IsRemote: bool
     :param LastUpdated: The last updated date
     :type LastUpdated: str
     :param Platform: The platform information object
     :type Platform: IPlatformInfo
-    :param Port: The port
-    :type Port: int
     :param State: The state
     :type State: RemoteInstanceState
     :param StateReason: The state reason
@@ -935,6 +925,8 @@ class IADSInstance:
     :type TagsList: str
     :param URL: The URL
     :type URL: str
+    :param Fitness: The fitness information object
+    :type Fitness: Optional[ProvisionFitness]
     """
     AvailableIPs: 'list[str]'
     AvailableInstances: 'list[InstanceSummary]'
@@ -943,22 +935,18 @@ class IADSInstance:
     Datastores: 'list[DatastoreSummary]'
     Description: 'str'
     Disabled: 'bool'
-    Fitness: 'ProvisionFitness'
     FriendlyName: 'str'
-    Host: 'str'
     Id: 'int'
     InstanceId: 'str'
-    Instances: 'list[InstanceSummary]'
-    IsHTTPS: 'bool'
     IsRemote: 'bool'
     LastUpdated: 'str'
     Platform: 'IPlatformInfo'
-    Port: 'int'
     State: 'RemoteInstanceState'
     StateReason: 'str'
     Tags: 'list[str]'
     TagsList: 'str'
     URL: 'str'
+    Fitness: 'Optional[ProvisionFitness]'
 
 @dataclass
 class IAuditLogEntry:

libraries/python/setup.cfg

@@ -1,6 +1,6 @@
 [metadata]
 name = ampapi
-version = 2604.4.2
+version = 2604.4.3
 author = Dylan Sperrer - p0t4t0sandwich - thepotatoking3452
 author_email = p0t4t0sandwich@gmail.com
 description = An API that allows you to communicate with AMP installations from within Python.

test.py

@@ -2,10 +2,10 @@
 import time
 
 from libraries.python.ampapi.auth import BasicAuthProvider, BasicAuthProviderAsync, RefreshingAuthProvider
-from libraries.python.ampapi.modules import CommonAPI, CommonAPIAsync
+from libraries.python.ampapi.modules import CommonAPI, CommonAPIAsync, ADSAsync
 from libraries.python.ampapi.types import MetricInfo
 
-PANEL_URL = "http://localhost:8080/API/ADSModule/Servers/TestServer01/"
+PANEL_URL = "http://localhost:8080"
 USERNAME = "api_user"
 PASSWORD = "api_user123!"
 
@@ -30,12 +30,15 @@ async def async_main():
         password=PASSWORD
     )
 
-    api = CommonAPIAsync(authProvider)
+    api = ADSAsync(authProvider)
 
-    print(await authProvider.instanceName)
-    print(await authProvider.instanceId)
+#    print(await authProvider.instanceName)
+#    print(await authProvider.instanceId)
 
-    print((await api.Core.GetStatus()).State)
+#    print((await api.Core.GetStatus()).State)
+
+    instances = await api.ADSModule.GetInstances(ForceIncludeSelf=False)
+    print(instances)
 
 now = time.time()
 main()