small updates (#10254)

Azure · Jul 28, 2020 · c18564b · c18564b
1 parent 69a5085
commit c18564b
Show file tree

Hide file tree

Showing 9 changed files with 57 additions and 53 deletions.
diff --git a/.../data-plane/Microsoft.IoTCentral/preview/2019-10-28-preview/examples/application_get.json b/.../data-plane/Microsoft.IoTCentral/preview/2019-10-28-preview/examples/application_get.json
@@ -2,8 +2,6 @@
   "title": "Get an application by Id",
   "description": "Get an application by Id.",
   "parameters": {
-    "centralDnsSuffixInPath": "azureiotcentral.com",
-    "subdomain": "appsubdomain",
     "application_id": "194e282c-290a-4858-b68f-4274690697fc"
   },
   "responses": {

diff --git a/...data-plane/Microsoft.IoTCentral/preview/2019-10-28-preview/examples/application_list.json b/...data-plane/Microsoft.IoTCentral/preview/2019-10-28-preview/examples/application_list.json
@@ -1,10 +1,7 @@
 {
   "title": "List applications",
   "description": "List applications that are accessible to the signed-in user.",
-  "parameters": {
-    "centralDnsSuffixInPath": "azureiotcentral.com",
-    "subdomain": "appsubdomain"
-  },
+  "parameters": {},
   "responses": {
     "200": {
       "body": {

diff --git a/...plane/Microsoft.IoTCentral/preview/2019-10-28-preview/examples/devicecredentials_get.json b/...plane/Microsoft.IoTCentral/preview/2019-10-28-preview/examples/devicecredentials_get.json
@@ -9,10 +9,10 @@
   "responses": {
     "200": {
       "body": {
-        "idScope": "<idScope>",
+        "idScope": "<ID scope>",
         "symmetricKey": {
-          "primaryKey": "XaMfV3vryCQw963L2IALf1SdApQRzSIBQd13/fassqM=",
-          "secondaryKey": "s+4uT31TRZJcTSGxZUPZb1yznjTicu4jr9tXNrg+xIQ="
+          "primaryKey": "<primary key>",
+          "secondaryKey": "<secondary key>"
         }
       }
     }

diff --git a/...IoTCentral/preview/2019-10-28-preview/examples/devices_attestations_set_symmetricKey.json b/...IoTCentral/preview/2019-10-28-preview/examples/devices_attestations_set_symmetricKey.json
@@ -8,8 +8,8 @@
     "body": {
       "type": "SymmetricKeyAttestation",
       "symmetricKey": {
-        "primaryKey": "XaMfV3vryCQw963L2IALf1SdApQRzSIBQd13/fassqM=",
-        "secondaryKey": "s+4uT31TRZJcTSGxZUPZb1yznjTicu4jr9tXNrg+xIQ="
+        "primaryKey": "<primary key>",
+        "secondaryKey": "<secondary key>"
       }
     }
   },
@@ -18,8 +18,8 @@
       "body": {
         "type": "SymmetricKeyAttestation",
         "symmetricKey": {
-          "primaryKey": "XaMfV3vryCQw963L2IALf1SdApQRzSIBQd13/fassqM=",
-          "secondaryKey": "s+4uT31TRZJcTSGxZUPZb1yznjTicu4jr9tXNrg+xIQ="
+          "primaryKey": "<primary key>",
+          "secondaryKey": "<secondary key>"
         }
       }
     }

diff --git a/...icrosoft.IoTCentral/preview/2019-10-28-preview/examples/devices_attestations_set_tpm.json b/...icrosoft.IoTCentral/preview/2019-10-28-preview/examples/devices_attestations_set_tpm.json
@@ -8,7 +8,7 @@
     "body": {
       "type": "TpmAttestation",
       "tpm": {
-        "endorsementKey": "AToAAQALAAMAsgAgg3GXZ0SEs/gakMyNRqXXJP1S124GUgtk8qHaGzMUaaoABgCAAEMAEAgAAAAAAAEAxsj2gUScTk1UjuioeTlfGYZrrimExB+bScH75adUMRIi2UOMxG1kw4y+9RW/IVoMl4e620VxZad0ARX2gUqVjYO7KPVt3dyKhZS3dkcvfBisBhP1XH9B33VqHG9SHnbnQXdBUaCgKAfxome8UmBKfe+naTsE5fkvjb/do3/dD6l4sGBwFCnKRdln4XpM03zLpoHFao8zOwt8l/uP3qUIxmCYv9A7m69Ms+5/pCkTu/rK4mRDsfhZ0QLfbzVI6zQFOKF/rwsfBtFeWlWtcuJMKlXdD8TXWElTzgh7JS4qhFzreL0c1mI0GCj+Aws0usZh7dLIVPnlgZcBhgy1SSDQMQ=="
+        "endorsementKey": "<endorsement key>"
       }
     }
   },
@@ -17,7 +17,7 @@
       "body": {
         "type": "TpmAttestation",
         "tpm": {
-          "endorsementKey": "AToAAQALAAMAsgAgg3GXZ0SEs/gakMyNRqXXJP1S124GUgtk8qHaGzMUaaoABgCAAEMAEAgAAAAAAAEAxsj2gUScTk1UjuioeTlfGYZrrimExB+bScH75adUMRIi2UOMxG1kw4y+9RW/IVoMl4e620VxZad0ARX2gUqVjYO7KPVt3dyKhZS3dkcvfBisBhP1XH9B33VqHG9SHnbnQXdBUaCgKAfxome8UmBKfe+naTsE5fkvjb/do3/dD6l4sGBwFCnKRdln4XpM03zLpoHFao8zOwt8l/uP3qUIxmCYv9A7m69Ms+5/pCkTu/rK4mRDsfhZ0QLfbzVI6zQFOKF/rwsfBtFeWlWtcuJMKlXdD8TXWElTzgh7JS4qhFzreL0c1mI0GCj+Aws0usZh7dLIVPnlgZcBhgy1SSDQMQ=="
+          "endorsementKey": "<endorsement key>"
         }
       }
     }

diff --git a/...lane/Microsoft.IoTCentral/preview/2019-10-28-preview/examples/devices_properties_get.json b/...lane/Microsoft.IoTCentral/preview/2019-10-28-preview/examples/devices_properties_get.json
@@ -1,6 +1,6 @@
 {
   "title": "Get device properties",
-  "description": "Get the current values of all device properties.",
+  "description": "Get the current values of all device properties. Properties that have never been set by the device or by a user or API request will not be returned.",
   "parameters": {
     "centralDnsSuffixInPath": "azureiotcentral.com",
     "subdomain": "appsubdomain",
@@ -11,13 +11,29 @@
       "body": {
         "deviceinfo": {
           "manufacturer": "manufacturer",
+          "$metadata": {
+            "manufacturer": {
+              "lastUpdateTime": "2020-07-21T19:06:50.9718608Z"
+            },
+            "model": {
+              "lastUpdateTime": "2020-07-21T19:06:50.9718608Z"
+            },
+            "swVersion": {
+              "lastUpdateTime": "2020-07-21T19:06:50.9718608Z"
+            }
+          },
           "model": "model",
-          "swVersion": "swVersion",
-          "osName": "osName",
-          "processorArchitecture": "processorArchitecture",
-          "processorManufacturer": "processorManufacturer",
-          "totalStorage": 41,
-          "totalMemory": 49
+          "swVersion": "swVersion"
+        },
+        "settings": {
+          "fanSpeed": 12.5,
+          "$metadata": {
+            "fanSpeed": {
+              "desiredValue": 30,
+              "desiredVersion": 2,
+              "lastUpdateTime": "2020-07-21T19:06:50.9718608Z"
+            }
+          }
         }
       }
     }

diff --git a/...e/Microsoft.IoTCentral/preview/2019-10-28-preview/examples/devices_properties_update.json b/...e/Microsoft.IoTCentral/preview/2019-10-28-preview/examples/devices_properties_update.json
@@ -6,30 +6,24 @@
     "subdomain": "appsubdomain",
     "device_id": "mx1",
     "body": {
-      "device_info": {
-        "manufacturer": "manufacturer",
-        "model": "model",
-        "swVersion": "swVersion",
-        "osName": "osName",
-        "processorArchitecture": "processorArchitecture",
-        "processorManufacturer": "processorManufacturer",
-        "totalStorage": 24,
-        "totalMemory": 18
+      "settings": {
+        "voltage": 25,
+        "current": 7
       }
     }
   },
   "responses": {
     "202": {
       "body": {
-        "deviceinfo": {
-          "manufacturer": "TODO",
-          "model": "model",
-          "swVersion": "swVersion",
-          "osName": "osName",
-          "processorArchitecture": "processorArchitecture",
-          "processorManufacturer": "processorManufacturer",
-          "totalStorage": 41,
-          "totalMemory": 49
+        "settings": {
+          "$metadata": {
+            "voltage": {
+              "desiredValue": 25
+            },
+            "current": {
+              "desiredValue": 7
+            }
+          }
         }
       }
     }

diff --git a/...lane/Microsoft.IoTCentral/preview/2019-10-28-preview/examples/devicetemplates_create.json b/...lane/Microsoft.IoTCentral/preview/2019-10-28-preview/examples/devicetemplates_create.json
@@ -1,6 +1,6 @@
 {
   "title": "Create a device template",
-  "description": "Creates and publishes a device template. In the body, specify the full device template object.",
+  "description": "Creates and publishes a device template. In the body, specify the full device template object. Default views will be automatically generated.",
   "parameters": {
     "centralDnsSuffixInPath": "azureiotcentral.com",
     "subdomain": "appsubdomain",
@@ -39,7 +39,7 @@
                   "displayName": "Temperature",
                   "name": "Temperature",
                   "schema": "double",
-                  "unit": "Units/Temperature/celsius"
+                  "unit": "celsius"
                 },
                 {
                   "@id": "urn:storeAnalyticsCheckoutPnp:Interface:Humidity:1",
@@ -50,7 +50,7 @@
                   "displayName": "Humidity",
                   "name": "Humidity",
                   "schema": "double",
-                  "unit": "Units/Humidity/percent"
+                  "unit": "percent"
                 },
                 {
                   "@id": "urn:storeAnalyticsCheckoutPnp:Interface:Occupancy:1",
@@ -110,7 +110,7 @@
                     "displayName": "Temperature",
                     "name": "Temperature",
                     "schema": "double",
-                    "unit": "Units/Temperature/celsius"
+                    "unit": "celsius"
                   },
                   {
                     "@id": "urn:storeAnalyticsCheckoutPnp:Interface:Humidity:1",
@@ -121,7 +121,7 @@
                     "displayName": "Humidity",
                     "name": "Humidity",
                     "schema": "double",
-                    "unit": "Units/Humidity/percent"
+                    "unit": "percent"
                   },
                   {
                     "@id": "urn:storeAnalyticsCheckoutPnp:Interface:Occupancy:1",

diff --git a/...ion/iotcentral/data-plane/Microsoft.IoTCentral/preview/2019-10-28-preview/iotcentral.json b/...ion/iotcentral/data-plane/Microsoft.IoTCentral/preview/2019-10-28-preview/iotcentral.json
@@ -304,10 +304,6 @@
           "description": "Display name of the device.",
           "type": "string"
         },
-        "description": {
-          "description": "Detailed description of the device.",
-          "type": "string"
-        },
         "instanceOf": {
           "description": "The device template definition for the device.",
           "type": "string"
@@ -504,7 +500,8 @@
           "properties": {
             "email": {
               "description": "Email address of the user.",
-              "type": "string"
+              "type": "string",
+              "format": "email"
             }
           },
           "required": [
@@ -1186,7 +1183,7 @@
     "/apiTokens": {
       "get": {
         "operationId": "ApiTokens_List",
-        "summary": "Get the list of API tokens in an application.",
+        "summary": "Get the list of API tokens in an application. The token value will never be returned for security reasons.",
         "x-ms-examples": {
           "List API tokens": {
             "$ref": "./examples/apitoken_list.json"
@@ -1234,7 +1231,7 @@
       },
       "put": {
         "operationId": "ApiTokens_Set",
-        "summary": "Create a new API token in the application.",
+        "summary": "Create a new API token in the application to use in the IoT Central public API. The token value will be returned in the response, and won't be returned again in subsequent requests.",
         "x-ms-examples": {
           "Create API token": {
             "$ref": "./examples/apitoken_create.json"
@@ -1446,7 +1443,7 @@
       },
       "put": {
         "operationId": "DeviceTemplates_Set",
-        "summary": "Create or update a device template",
+        "summary": "Publish a new device template or update the cloud properties and overrides of an existing device template. Default views will be automatically generated for new device templates created this way.",
         "x-ms-examples": {
           "Create a device template": {
             "$ref": "./examples/devicetemplates_create.json"
@@ -1943,6 +1940,7 @@
       "get": {
         "operationId": "Devices_GetComponentTelemetryValue",
         "summary": "Get device telemetry value",
+        "description": "Get the last telemetry value from a device.",
         "x-ms-examples": {
           "Get telemetry": {
             "$ref": "./examples/devices_telemetry_get.json"
@@ -2192,6 +2190,7 @@
       "get": {
         "operationId": "Devices_GetModuleComponentTelemetryValue",
         "summary": "Get module telemetry value",
+        "description": "Get the last telemetry value from a module.",
         "x-ms-examples": {
           "Get telemetry from module": {
             "$ref": "./examples/modules_telemetry_get.json"