From 630aeeb404c53a7b30a6955bbb3d152fefb2a48b Mon Sep 17 00:00:00 2001 From: Vivian Liu Date: Fri, 28 Feb 2020 14:13:06 -0800 Subject: [PATCH 1/8] Individual enrollments updates --- .../examples/devices_attestations_delete.json | 11 + .../examples/devices_attestations_get.json | 25 + .../examples/devices_attestations_set.json | 35 + .../2019-10-28-preview/iotcentral.json | 2612 ++++++++++------- 4 files changed, 1541 insertions(+), 1142 deletions(-) create mode 100644 specification/iotcentral/data-plane/Microsoft.IoTCentral/preview/2019-10-28-preview/examples/devices_attestations_delete.json create mode 100644 specification/iotcentral/data-plane/Microsoft.IoTCentral/preview/2019-10-28-preview/examples/devices_attestations_get.json create mode 100644 specification/iotcentral/data-plane/Microsoft.IoTCentral/preview/2019-10-28-preview/examples/devices_attestations_set.json diff --git a/specification/iotcentral/data-plane/Microsoft.IoTCentral/preview/2019-10-28-preview/examples/devices_attestations_delete.json b/specification/iotcentral/data-plane/Microsoft.IoTCentral/preview/2019-10-28-preview/examples/devices_attestations_delete.json new file mode 100644 index 000000000000..ccef956aeb41 --- /dev/null +++ b/specification/iotcentral/data-plane/Microsoft.IoTCentral/preview/2019-10-28-preview/examples/devices_attestations_delete.json @@ -0,0 +1,11 @@ +{ + "title": "Delete device attestation", + "description": "Deletes the attestation for a device.", + "parameters": { + "centralDnsSuffixInPath": "azureiotcentral.com", + "subdomain": "appsubdomain" + }, + "responses": { + "204": {} + } +} diff --git a/specification/iotcentral/data-plane/Microsoft.IoTCentral/preview/2019-10-28-preview/examples/devices_attestations_get.json b/specification/iotcentral/data-plane/Microsoft.IoTCentral/preview/2019-10-28-preview/examples/devices_attestations_get.json new file mode 100644 index 000000000000..da001f1ca9cb --- /dev/null +++ b/specification/iotcentral/data-plane/Microsoft.IoTCentral/preview/2019-10-28-preview/examples/devices_attestations_get.json @@ -0,0 +1,25 @@ +{ + "title": "Get device attestation", + "description": "Gets the attestation for a device.", + "parameters": { + "centralDnsSuffixInPath": "azureiotcentral.com", + "subdomain": "appsubdomain", + "device_id": "CheckoutThermostat" + }, + "responses": { + "200": { + "body": { + "type": "X509Attestation", + "x509": { + "clientCertificates": { + "primary": { + "info": { + "sha1Thumbprint": "" + } + } + } + } + } + } + } +} diff --git a/specification/iotcentral/data-plane/Microsoft.IoTCentral/preview/2019-10-28-preview/examples/devices_attestations_set.json b/specification/iotcentral/data-plane/Microsoft.IoTCentral/preview/2019-10-28-preview/examples/devices_attestations_set.json new file mode 100644 index 000000000000..b38f3195d2bd --- /dev/null +++ b/specification/iotcentral/data-plane/Microsoft.IoTCentral/preview/2019-10-28-preview/examples/devices_attestations_set.json @@ -0,0 +1,35 @@ +{ + "title": "Set device attestation", + "description": "Creates or updates the attestation for a device.", + "parameters": { + "centralDnsSuffixInPath": "azureiotcentral.com", + "subdomain": "appsubdomain", + "device_id": "CheckoutThermostat", + "body": { + "type": "X509Attestation", + "x509": { + "clientCertificates": { + "primary": { + "certificate": "" + } + } + } + } + }, + "responses": { + "200": { + "body": { + "type": "X509Attestation", + "x509": { + "clientCertificates": { + "primary": { + "info": { + "sha1Thumbprint": "" + } + } + } + } + } + } + } +} diff --git a/specification/iotcentral/data-plane/Microsoft.IoTCentral/preview/2019-10-28-preview/iotcentral.json b/specification/iotcentral/data-plane/Microsoft.IoTCentral/preview/2019-10-28-preview/iotcentral.json index f7f799c7cd66..de7e883a624c 100644 --- a/specification/iotcentral/data-plane/Microsoft.IoTCentral/preview/2019-10-28-preview/iotcentral.json +++ b/specification/iotcentral/data-plane/Microsoft.IoTCentral/preview/2019-10-28-preview/iotcentral.json @@ -1,1574 +1,1902 @@ { - "swagger": "2.0", - "info": { - "version": "preview", - "title": "Azure IoT Central", - "description": "Azure IoT Central is a service that makes it easy to connect, monitor, and manage your IoT devices at scale." + "swagger":"2.0", + "info":{ + "version":"preview", + "title":"Azure IoT Central", + "description":"Azure IoT Central is a service that makes it easy to connect, monitor, and manage your IoT devices at scale." }, - "basePath": "/api/preview", - "schemes": [ + "basePath":"/api/preview", + "schemes":[ "https" ], - "consumes": [ + "consumes":[ "application/json" ], - "produces": [ + "produces":[ "application/json" ], - "definitions": { - "ApiToken": { - "type": "object", - "allOf": [ + "definitions":{ + "ApiToken":{ + "allOf":[ { - "$ref": "#/definitions/Permission" + "$ref":"#/definitions/Permission" }, { - "properties": { - "id": { - "description": "Unique ID of the api token.", - "type": "string", - "readOnly": true + "type":"object", + "properties":{ + "id":{ + "description":"Unique ID of the API token.", + "type":"string", + "readOnly":true }, - "token": { - "description": "Value of the api token.", - "type": "string", - "readOnly": true + "token":{ + "description":"Value of the API token.", + "type":"string", + "readOnly":true }, - "expiry": { - "description": "String-formatted date representing the time when the token expires", - "type": "string", - "format": "date-time" + "expiry":{ + "description":"String-formatted date representing the time when the token expires.", + "type":"string", + "format":"date-time" } } } ] }, - "ApiTokenCollection": { - "type": "object", - "properties": { - "value": { - "description": "The collection of api tokens.", - "type": "array", - "items": { - "$ref": "#/definitions/ApiToken" - } + "ApiTokenCollection":{ + "type":"object", + "properties":{ + "value":{ + "description":"The collection of API tokens.", + "type":"array", + "items":{ + "$ref":"#/definitions/ApiToken" + } + }, + "nextLink":{ + "description":"URL to get the next page of API tokens.", + "type":"string" } }, - "required": [ + "required":[ "value" ] }, - "Capability": { - "type": "object", - "allOf": [ + "Attestation":{ + "type":"object", + "properties":{ + "type":{ + "description":"Type of the attestation.", + "type":"string" + } + }, + "required":[ + "type" + ], + "discriminator":"type" + }, + "SymmetricKeyAttestation":{ + "allOf":[ + { + "$ref":"#/definitions/Attestation" + }, + { + "type":"object", + "properties":{ + "symmetricKey":{ + "description":"The symmetric key credentials for this attestation.", + "$ref":"#/definitions/SymmetricKey" + } + }, + "required":[ + "symmetricKey" + ] + } + ] + }, + "X509Attestation":{ + "allOf":[ + { + "$ref":"#/definitions/Attestation" + }, + { + "type":"object", + "properties":{ + "x509":{ + "description":"The X.509 credentials for this attestation.", + "$ref":"#/definitions/X509" + } + }, + "required":[ + "x509" + ] + } + ] + }, + "TpmAttestation":{ + "allOf":[ + { + "$ref":"#/definitions/Attestation" + }, + { + "type":"object", + "properties":{ + "tpm":{ + "description":"The TPM credentials for this attestation.", + "$ref":"#/definitions/Tpm" + } + }, + "required":[ + "tpm" + ] + } + ] + }, + "SchemaField":{ + "allOf":[ + { + "$ref":"#/definitions/NamedEntity" + }, + { + "type":"object", + "properties":{ + "schema":{ + "description":"The schema of this field." + }, + "displayUnit":{ + "description":"The display name of the unit of this field.", + "type":"string" + }, + "unit":{ + "description":"The unit of this field.", + "type":"string" + } + }, + "required":[ + "schema" + ] + } + ] + }, + "Capability":{ + "allOf":[ + { + "$ref":"#/definitions/NamedEntity" + }, + { + "type":"object", + "properties":{ + "schema":{ + "description":"The schema of this field." + }, + "displayUnit":{ + "description":"The display name of the unit of this field.", + "type":"string" + }, + "unit":{ + "description":"The unit of this field.", + "type":"string" + } + } + }, + { + "type":"object", + "properties":{ + "commandType":{ + "description":"The call pattern of this command.", + "type":"string", + "enum":[ + "synchronous", + "asynchronous" + ] + }, + "request":{ + "description":"The request definition for this command.", + "$ref":"#/definitions/SchemaField" + }, + "response":{ + "description":"The response definition for this command.", + "$ref":"#/definitions/SchemaField" + } + } + }, { - "$ref": "#/definitions/NamedEntity" + "type":"object", + "properties":{ + "writable":{ + "description":"Whether this property is writable.", + "type":"boolean" + } + } }, { - "properties": { - "name": { - "description": "The programmatic name of the named entity.", - "type": "string" + "type":"object", + "properties":{ + "target":{ + "description":"The target capability models for this relationship.", + "type":"array", + "items":{ + "type":"string" + }, + "minItems":1 + }, + "maxMultiplicity":{ + "description":"The maximum multiplicity for this relationship.", + "type":"integer" } } } - ], - "additionalProperties": true + ] }, - "Interface": { - "type": "object", - "allOf": [ + "Interface":{ + "allOf":[ { - "$ref": "#/definitions/Entity" + "$ref":"#/definitions/Entity" }, { - "properties": { - "contents": { - "description": "The data definitions contained by the interface.", - "type": "array", - "items": { - "$ref": "#/definitions/Capability" + "type":"object", + "properties":{ + "contents":{ + "description":"The data definitions contained by the interface.", + "type":"array", + "items":{ + "$ref":"#/definitions/Capability" } } } } ] }, - "Component": { - "type": "object", - "allOf": [ + "Component":{ + "allOf":[ { - "$ref": "#/definitions/NamedEntity" + "$ref":"#/definitions/NamedEntity" }, { - "properties": { - "schema": { - "description": "The interface used by this component.", - "$ref": "#/definitions/Interface" + "type":"object", + "properties":{ + "schema":{ + "description":"The interface used by this component.", + "$ref":"#/definitions/Interface" } } } ] }, - "CapabilityModel": { - "type": "object", - "allOf": [ + "CapabilityModel":{ + "allOf":[ { - "$ref": "#/definitions/Entity" + "$ref":"#/definitions/Entity" }, { - "properties": { - "implements": { - "description": "The component implemented by the capability model.", - "type": "array", - "items": { - "$ref": "#/definitions/Component" + "type":"object", + "properties":{ + "implements":{ + "description":"The component implemented by the capability model.", + "type":"array", + "items":{ + "$ref":"#/definitions/Component" } }, - "contents": { - "description": "The relationships contained by the capability model.", - "type": "array", - "items": { - "$ref": "#/definitions/NamedEntity" + "contents":{ + "description":"The relationships contained by the capability model.", + "type":"array", + "items":{ + "$ref":"#/definitions/Capability" } } } } ] }, - "Endpoint": { - "type": "object", - "properties": { - "type": { - "description": "Type of the endpoint.", - "type": "string" - }, - "connectionString": { - "description": "Information for connecting to the endpoint.", - "type": "string" - }, - "name": { - "description": "Name of the entity to send data to.", - "type": "string" + "Endpoint":{ + "type":"object", + "properties":{ + "type":{ + "description":"Type of the endpoint.", + "type":"string" + }, + "connectionString":{ + "description":"Information for connecting to the endpoint.", + "type":"string" + }, + "name":{ + "description":"Name of the entity to send data to.", + "type":"string" } }, - "required": [ + "required":[ "type", "connectionString", "name" ], - "discriminator": "type" + "discriminator":"type" }, - "StorageEndpoint": { - "allOf": [ + "StorageEndpoint":{ + "allOf":[ { - "$ref": "#/definitions/Endpoint" + "$ref":"#/definitions/Endpoint" } ] }, - "EventHubsEndpoint": { - "allOf": [ + "EventHubsEndpoint":{ + "allOf":[ { - "$ref": "#/definitions/Endpoint" + "$ref":"#/definitions/Endpoint" } ] }, - "ServiceBusQueueEndpoint": { - "allOf": [ + "ServiceBusQueueEndpoint":{ + "allOf":[ { - "$ref": "#/definitions/Endpoint" + "$ref":"#/definitions/Endpoint" } ] }, - "ServiceBusTopicEndpoint": { - "allOf": [ + "ServiceBusTopicEndpoint":{ + "allOf":[ { - "$ref": "#/definitions/Endpoint" + "$ref":"#/definitions/Endpoint" } ] }, - "ContinuousDataExport": { - "type": "object", - "properties": { - "id": { - "description": "Unique ID of the continuous data export.", - "type": "string", - "readOnly": true - }, - "etag": { - "description": "ETag used to prevent conflict in continuous data export updates.", - "type": "string" - }, - "displayName": { - "description": "Display name of the continuous data export.", - "type": "string" - }, - "endpoint": { - "description": "Location where exported data should be sent.", - "$ref": "#/definitions/Endpoint" - }, - "status": { - "description": "Indicates whether the continuous data export is starting, running, etc.", - "type": "string", - "readOnly": true - }, - "enabled": { - "description": "Boolean indicating whether the continuous data export should be running or not.", - "type": "boolean" - }, - "sources": { - "description": "Data sources to export to the endpoint.", - "type": "array", - "items": { - "type": "string", - "enum": [ + "ContinuousDataExport":{ + "type":"object", + "properties":{ + "id":{ + "description":"Unique ID of the continuous data export.", + "type":"string", + "readOnly":true + }, + "etag":{ + "description":"ETag used to prevent conflict in continuous data export updates.", + "type":"string" + }, + "displayName":{ + "description":"Display name of the continuous data export.", + "type":"string" + }, + "endpoint":{ + "description":"Location where exported data should be sent.", + "$ref":"#/definitions/Endpoint" + }, + "status":{ + "description":"Indicates whether the continuous data export is starting, running, etc.", + "type":"string", + "readOnly":true + }, + "enabled":{ + "description":"Boolean indicating whether the continuous data export should be running or not.", + "type":"boolean" + }, + "sources":{ + "description":"Data sources to export to the endpoint.", + "type":"array", + "items":{ + "type":"string", + "enum":[ "devices", "deviceTemplates", "telemetry" ] }, - "minItems": 1 + "minItems":1 } }, - "required": [ + "required":[ "endpoint", "enabled", "sources" ] }, - "ContinuousDataExportCollection": { - "type": "object", - "properties": { - "value": { - "description": "The collection of continuous data exports.", - "type": "array", - "items": { - "$ref": "#/definitions/ContinuousDataExport" - } - }, - "nextLink": { - "description": "URL to get the next page of continuous data exports.", - "type": "string" + "ContinuousDataExportCollection":{ + "type":"object", + "properties":{ + "value":{ + "description":"The collection of continuous data exports.", + "type":"array", + "items":{ + "$ref":"#/definitions/ContinuousDataExport" + } + }, + "nextLink":{ + "description":"URL to get the next page of continuous data exports.", + "type":"string" } }, - "required": [ + "required":[ "value" ] }, - "Device": { - "type": "object", - "properties": { - "id": { - "description": "Unique ID of the device.", - "type": "string", - "readOnly": true - }, - "etag": { - "description": "ETag used to prevent conflict in device updates.", - "type": "string" - }, - "displayName": { - "description": "Display name of the device.", - "type": "string" - }, - "description": { - "description": "Detailed description of the device.", - "type": "string" - }, - "instanceOf": { - "description": "The model definition for the device.", - "type": "string" - }, - "simulated": { - "description": "Whether the device is simulated.", - "type": "boolean" - }, - "approved": { - "description": "Whether the device has been approved to connect to IoT Central.", - "type": "boolean" - }, - "provisioned": { - "description": "Whether resources have been allocated for the device.", - "type": "boolean", - "readOnly": true + "Device":{ + "type":"object", + "properties":{ + "id":{ + "description":"Unique ID of the device.", + "type":"string", + "readOnly":true + }, + "etag":{ + "description":"ETag used to prevent conflict in device updates.", + "type":"string" + }, + "displayName":{ + "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" + }, + "simulated":{ + "description":"Whether the device is simulated.", + "type":"boolean" + }, + "approved":{ + "description":"Whether the device has been approved to connect to IoT Central.", + "type":"boolean" + }, + "provisioned":{ + "description":"Whether resources have been allocated for the device.", + "type":"boolean", + "readOnly":true } }, - "required": [ + "required":[ "instanceOf" ] }, - "DeviceCollection": { - "type": "object", - "properties": { - "value": { - "description": "The collection of devices.", - "type": "array", - "items": { - "$ref": "#/definitions/Device" - } - }, - "nextLink": { - "description": "URL to get the next page of devices.", - "type": "string" + "DeviceCollection":{ + "type":"object", + "properties":{ + "value":{ + "description":"The collection of devices.", + "type":"array", + "items":{ + "$ref":"#/definitions/Device" + } + }, + "nextLink":{ + "description":"URL to get the next page of devices.", + "type":"string" } }, - "required": [ + "required":[ "value" ] }, - "DeviceCommand": { - "type": "object", - "properties": { - "id": { - "description": "The request ID of the device command execution.", - "type": "string", - "readOnly": true - }, - "request": { - "description": "The payload for the device command." - }, - "response": { - "description": "The payload of the device command response.", - "readOnly": true - }, - "responseCode": { - "description": "The status code of the device command response.", - "type": "number", - "readOnly": true + "DeviceCloudProperties":{ + "description":"Cloud property values associated with the device.", + "type":"object", + "additionalProperties":true + }, + "DeviceCommand":{ + "type":"object", + "properties":{ + "id":{ + "description":"The request ID of the device command execution.", + "type":"string", + "readOnly":true + }, + "request":{ + "description":"The payload for the device command." + }, + "response":{ + "description":"The payload of the device command response.", + "readOnly":true + }, + "responseCode":{ + "description":"The status code of the device command response.", + "type":"integer", + "readOnly":true } } }, - "DeviceCommandCollection": { - "type": "object", - "properties": { - "value": { - "description": "The collection of device command executions.", - "type": "array", - "items": { - "$ref": "#/definitions/DeviceCommand" - } + "DeviceCommandCollection":{ + "type":"object", + "properties":{ + "value":{ + "description":"The collection of device command executions.", + "type":"array", + "items":{ + "$ref":"#/definitions/DeviceCommand" + } + }, + "nextLink":{ + "description":"URL to get the next page of device command executions.", + "type":"string" } }, - "required": [ + "required":[ "value" ] }, - "DeviceCloudProperties": { - "description": "Cloud property values associated with the device.", - "type": "object", - "additionalProperties": true + "DeviceCredentials":{ + "type":"object", + "properties":{ + "idScope":{ + "description":"ID scope for connecting to the IoT Central application.", + "type":"string" + }, + "symmetricKey":{ + "description":"The symmetric key credentials for the device.", + "$ref":"#/definitions/SymmetricKey" + }, + "x509":{ + "description":"The X.509 credential information for the device.", + "$ref":"#/definitions/X509" + }, + "tpm":{ + "description":"The TPM credentials for the device.", + "$ref":"#/definitions/Tpm" + } + }, + "required":[ + "idScope" + ] }, - "SymmetricKey": { - "type": "object", - "properties": { - "primaryKey": { - "description": "The primary key for the credential.", - "type": "string" - }, - "secondaryKey": { - "description": "The secondary key for the credential.", - "type": "string" + "DeviceProperties":{ + "description":"Property values associated with the device.", + "type":"object", + "additionalProperties":true + }, + "DeviceTelemetry":{ + "type":"object", + "properties":{ + "value":{ + "description":"The last known value of this device telemetry." + }, + "timestamp":{ + "description":"String-formatted date representing the time when the telemetry value was sent.", + "type":"string", + "format":"date-time" + } + } + }, + "DeviceTemplate":{ + "type":"object", + "properties":{ + "id":{ + "description":"Unique ID of the device template.", + "type":"string", + "readOnly":true + }, + "etag":{ + "description":"ETag used to prevent conflict in device template updates.", + "type":"string" + }, + "types":{ + "description":"The types of device to which this template applies.", + "type":"array", + "items":{ + "type":"string" + } + }, + "displayName":{ + "description":"Display name of the device template.", + "type":"string" + }, + "description":{ + "description":"Detailed description of the device template.", + "type":"string" + }, + "capabilityModel":{ + "description":"The capability model utilized by this device template.", + "$ref":"#/definitions/CapabilityModel" + }, + "solutionModel":{ + "description":"The solution model utilized by this device template.", + "$ref":"#/definitions/SolutionModel" } }, - "required": [ + "required":[ + "types", + "capabilityModel" + ] + }, + "DeviceTemplateCollection":{ + "type":"object", + "properties":{ + "value":{ + "description":"The collection of device templates.", + "type":"array", + "items":{ + "$ref":"#/definitions/DeviceTemplate" + } + }, + "nextLink":{ + "description":"URL to get the next page of device templates.", + "type":"string" + } + }, + "required":[ + "value" + ] + }, + "SymmetricKey":{ + "type":"object", + "properties":{ + "primaryKey":{ + "description":"The primary key for this credential.", + "type":"string" + }, + "secondaryKey":{ + "description":"The secondary key for this credential.", + "type":"string" + } + }, + "required":[ "primaryKey", "secondaryKey" ] }, - "DeviceCredentials": { - "type": "object", - "properties": { - "scopeId": { - "description": "Scope id for connecting to device provisioning service.", - "type": "string" - }, - "symmetricKey": { - "description": "The symmetric key credentials for the device.", - "$ref": "#/definitions/SymmetricKey" + "Tpm":{ + "type":"object", + "properties":{ + "endorsementKey":{ + "description":"The TPM endorsement key for this credential.", + "type":"string" } }, - "required": [ - "scopeId", - "symmetricKey" + "required":[ + "endorsementKey" ] }, - "DeviceProperties": { - "description": "Property values associated with the device.", - "type": "object", - "additionalProperties": true + "X509":{ + "type":"object", + "properties":{ + "clientCertificates":{ + "description":"The X.509 client certificates for this credential.", + "$ref":"#/definitions/X509Certificates" + } + }, + "required":[ + "clientCertificates" + ] }, - "DeviceTemplate": { - "type": "object", - "properties": { - "id": { - "description": "Unique ID of the device template.", - "type": "string", - "readOnly": true - }, - "etag": { - "description": "ETag used to prevent conflict in device template updates.", - "type": "string" - }, - "types": { - "description": "The types of device to which this template applies.", - "type": "array", - "items": { - "type": "string" - } - }, - "displayName": { - "description": "Display name of the device template.", - "type": "string" - }, - "description": { - "description": "Detailed description of the device template.", - "type": "string" - }, - "capabilityModel": { - "$ref": "#/definitions/CapabilityModel" - }, - "solutionModel": { - "$ref": "#/definitions/SolutionModel" + "X509Certificates":{ + "type":"object", + "properties":{ + "primary":{ + "description":"The primary X.509 certificate for this credential.", + "$ref":"#/definitions/X509Certificate" + }, + "secondary":{ + "description":"The secondary X.509 certificate for this credential.", + "$ref":"#/definitions/X509Certificate" } }, - "required": [ - "types", - "capabilityModel" + "required":[ + "primary" ] }, - "DeviceTemplateCollection": { - "type": "object", - "properties": { - "value": { - "description": "The collection of device templates.", - "type": "array", - "items": { - "$ref": "#/definitions/DeviceTemplate" - } - }, - "nextLink": { - "description": "URL to get the next page of device templates.", - "type": "string" + "X509Certificate":{ + "type":"object", + "properties":{ + "certificate":{ + "description":"The string representation of this certificate.", + "type":"string" + }, + "info":{ + "description":"Information about this certificate.", + "readOnly":true, + "$ref":"#/definitions/X509CertificateInfo" + } + } + }, + "X509CertificateInfo":{ + "type":"object", + "properties":{ + "sha1Thumbprint":{ + "description":"The SHA-1 hash value of the certificate.", + "type":"string" } }, - "required": [ - "value" + "required":[ + "sha1Thumbprint" ] }, - "Entity": { - "type": "object", - "properties": { - "@context": { - "description": "JSON-LD context for the entity." - }, - "@id": { - "description": "Unique ID of the entity.", - "type": "string" - }, - "@type": { - "description": "Type of the entity.", - "type": "array", - "items": { - "type": "string" + "Entity":{ + "type":"object", + "properties":{ + "@context":{ + "description":"JSON-LD context for the entity." + }, + "@id":{ + "description":"Unique ID of the entity.", + "type":"string" + }, + "@type":{ + "description":"Type of the entity.", + "type":"array", + "items":{ + "type":"string" }, - "minItems": 1 + "minItems":1 }, - "displayName": { - "description": "Display name of the entity.", - "type": "string" + "displayName":{ + "description":"Display name of the entity.", + "type":"string" }, - "description": { - "description": "Detailed description of the entity.", - "type": "string" + "description":{ + "description":"Detailed description of the entity.", + "type":"string" }, - "comment": { - "description": "Developer comment about the entity.", - "type": "string" + "comment":{ + "description":"Developer comment about the entity.", + "type":"string" } }, - "required": [ + "required":[ "@type" ] }, - "NamedEntity": { - "type": "object", - "allOf": [ + "NamedEntity":{ + "allOf":[ { - "$ref": "#/definitions/Entity" + "$ref":"#/definitions/Entity" }, { - "properties": { - "name": { - "description": "The programmatic name of the named entity.", - "type": "string" + "type":"object", + "properties":{ + "name":{ + "description":"The programmatic name of the named entity.", + "type":"string" } }, - "required": [ + "required":[ "name" ] } ] }, - "Permission": { - "type": "object", - "properties": { - "roles": { - "description": "Roles that the permission has been granted permission to.", - "type": "array", - "items": { - "type": "string" + "Permission":{ + "type":"object", + "properties":{ + "roles":{ + "description":"Roles that the permission has been granted permission to.", + "type":"array", + "items":{ + "type":"string" }, - "minItems": 1, - "maxItems": 1 + "minItems":1, + "maxItems":1 } }, - "required": [ + "required":[ "roles" ] }, - "Value": { - "type": "object", - "properties": { - "value": { - "description": "The value of this API response." - } - } - }, - "Role": { - "type": "object", - "properties": { - "id": { - "description": "Unique ID of the role.", - "type": "string", - "readOnly": true - }, - "displayName": { - "description": "Display name of the role.", - "type": "string" + "Role":{ + "type":"object", + "properties":{ + "id":{ + "description":"Unique ID of the role.", + "type":"string", + "readOnly":true + }, + "displayName":{ + "description":"Display name of the role.", + "type":"string" } } }, - "RoleCollection": { - "type": "object", - "properties": { - "value": { - "description": "The collection of roles.", - "type": "array", - "items": { - "$ref": "#/definitions/Role" - } + "RoleCollection":{ + "type":"object", + "properties":{ + "value":{ + "description":"The collection of roles.", + "type":"array", + "items":{ + "$ref":"#/definitions/Role" + } + }, + "nextLink":{ + "description":"URL to get the next page of roles.", + "type":"string" } }, - "required": [ + "required":[ "value" ] }, - "SolutionModel": { - "type": "object", - "allOf": [ + "SolutionModel":{ + "allOf":[ { - "$ref": "#/definitions/Entity" + "$ref":"#/definitions/Entity" }, { - "properties": { - "cloudProperties": { - "description": "The cloud properties defined by the solution model.", - "type": "array", - "items": { - "$ref": "#/definitions/Capability" + "type":"object", + "properties":{ + "cloudProperties":{ + "description":"The cloud properties defined by the solution model.", + "type":"array", + "items":{ + "$ref":"#/definitions/Capability" } }, - "initialValues": { - "description": "The initial values defined by the solution model.", - "type": "array", - "items": { - "$ref": "#/definitions/InitialValue" + "initialValues":{ + "description":"The initial values defined by the solution model.", + "type":"array", + "items":{ + "$ref":"#/definitions/InitialValue" } }, - "overrides": { - "description": "The overrides defined by the solution model.", - "type": "array", - "items": { - "$ref": "#/definitions/Override" + "overrides":{ + "description":"The overrides defined by the solution model.", + "type":"array", + "items":{ + "$ref":"#/definitions/Override" } } } } ] }, - "InitialValue": { - "type": "object", - "allOf": [ + "InitialValue":{ + "allOf":[ { - "$ref": "#/definitions/Entity" + "$ref":"#/definitions/Entity" }, { - "properties": { - "capability": { - "$ref": "#/definitions/CapabilityReference" + "type":"object", + "properties":{ + "capability":{ + "description":"The reference to the capability for which an initial value is being provided.", + "$ref":"#/definitions/CapabilityReference" }, - "value": { - "description": "The initial value of the capability." + "value":{ + "description":"The initial value of the capability." } } } ] }, - "Override": { - "type": "object", - "allOf": [ + "Override":{ + "allOf":[ { - "$ref": "#/definitions/Entity" + "$ref":"#/definitions/Entity" }, { - "properties": { - "capability": { - "$ref": "#/definitions/CapabilityReference" + "type":"object", + "properties":{ + "capability":{ + "description":"The reference to the capability which is being overridden.", + "$ref":"#/definitions/CapabilityReference" }, - "displayUnit": { - "description": "The overridden display unit.", - "type": "string" + "displayUnit":{ + "description":"The overridden display unit for the referenced capability.", + "type":"string" }, - "semanticType": { - "description": "The overridden semantic type.", - "type": "string" + "semanticType":{ + "description":"The overridden semantic type for the referenced capability.", + "type":"string" }, - "unit": { - "description": "The overridden unit.", - "type": "string" + "unit":{ + "description":"The overridden unit for the referenced capability.", + "type":"string" }, - "valueDetail": { - "$ref": "#/definitions/ValueDetail" + "valueDetail":{ + "description":"Visualization details for the referenced capability.", + "$ref":"#/definitions/ValueDetail" } } } ] }, - "ValueDetail": { - "description": "Visualization details for the referenced capability.", - "type": "object", - "allOf": [ + "ValueDetail":{ + "allOf":[ + { + "$ref":"#/definitions/Entity" + }, + { + "type":"object", + "properties":{ + "falseName":{ + "description":"The string representation of a false value.", + "type":"string" + }, + "trueName":{ + "description":"The string representation of a true value.", + "type":"string" + } + } + }, + { + "type":"object", + "properties":{ + "hideTime":{ + "description":"Specifies that the time portion of the date-time value should be hidden.", + "type":"boolean" + } + } + }, + { + "type":"object", + "properties":{ + "severity":{ + "description":"Specifies the severity of the event.", + "type":"string", + "enum":[ + "error", + "warning", + "information" + ] + } + } + }, + { + "type":"object", + "properties":{ + "decimalPlaces":{ + "description":"The number of decimal places that should be displayed for the number.", + "type":"integer" + }, + "maxValue":{ + "description":"The maximum expected value of the number.", + "type":"number" + }, + "minValue":{ + "description":"The minimum expected value of the number.", + "type":"number" + } + } + }, { - "$ref": "#/definitions/Entity" + "type":"object", + "properties":{ + "maxLength":{ + "description":"The maximum expected length of the string.", + "type":"integer" + }, + "minLength":{ + "description":"The minimum expected length of the string.", + "type":"integer" + }, + "trimWhitespace":{ + "description":"Specifies the visual and storage treatment of whitespaces in the string.", + "type":"boolean" + } + } } - ], - "additionalProperties": true + ] }, - "CapabilityReference": { - "type": "object", - "allOf": [ + "CapabilityReference":{ + "allOf":[ { - "$ref": "#/definitions/Entity" + "$ref":"#/definitions/Entity" }, { - "properties": { - "component": { - "description": "The name of the component being referenced.", - "type": "string" + "type":"object", + "properties":{ + "component":{ + "description":"The name of the component being referenced.", + "type":"string" }, - "reference": { - "description": "The name of the capability being referenced.", - "type": "string" + "reference":{ + "description":"The name of the capability being referenced.", + "type":"string" } } } ] } }, - "paths": { - "/apiTokens": { - "get": { - "operationId": "ApiTokens_List", - "summary": "Get the list of API tokens in an application.", - "x-ms-examples": { - "List API tokens": { - "$ref": "./examples/apitoken_list.json" - } - }, - "responses": { - "200": { - "description": "Success", - "schema": { - "$ref": "#/definitions/ApiTokenCollection" + "paths":{ + "/apiTokens":{ + "get":{ + "operationId":"ApiTokens_List", + "summary":"Get the list of API tokens in an application.", + "x-ms-examples":{ + "List API tokens":{ + "$ref":"./examples/apitoken_list.json" + } + }, + "responses":{ + "200":{ + "description":"Success", + "schema":{ + "$ref":"#/definitions/ApiTokenCollection" } } - }, - "x-ms-pageable": { - "nextLinkName": null } } }, - "/apiTokens/{token_id}": { - "get": { - "operationId": "ApiTokens_Get", - "summary": "Get an API token by ID.", - "x-ms-examples": { - "Get API token by ID": { - "$ref": "./examples/apitoken_get.json" - } - }, - "parameters": [ - { - "in": "path", - "name": "token_id", - "description": "Unique ID for the API token.", - "type": "string", - "required": true - } - ], - "responses": { - "200": { - "description": "Success", - "schema": { - "$ref": "#/definitions/ApiToken" + "/apiTokens/{token_id}":{ + "parameters":[ + { + "in":"path", + "name":"token_id", + "description":"Unique ID for the API token.", + "type":"string", + "required":true + } + ], + "get":{ + "operationId":"ApiTokens_Get", + "summary":"Get an API token by ID.", + "x-ms-examples":{ + "Get API token by ID":{ + "$ref":"./examples/apitoken_get.json" + } + }, + "responses":{ + "200":{ + "description":"Success", + "schema":{ + "$ref":"#/definitions/ApiToken" } } } }, - "put": { - "operationId": "ApiTokens_Set", - "summary": "Create a new API token in the application.", - "x-ms-examples": { - "Create API token": { - "$ref": "./examples/apitoken_create.json" + "put":{ + "operationId":"ApiTokens_Set", + "summary":"Create a new API token in the application.", + "x-ms-examples":{ + "Create API token":{ + "$ref":"./examples/apitoken_create.json" } }, - "parameters": [ + "parameters":[ { - "in": "path", - "name": "token_id", - "description": "Unique ID for the API token.", - "type": "string", - "required": true + "in":"path", + "name":"token_id", + "description":"Unique ID for the API token.", + "type":"string", + "required":true }, { - "name": "body", - "in": "body", - "description": "API token body.", - "required": true, - "schema": { - "$ref": "#/definitions/ApiToken" + "name":"body", + "in":"body", + "description":"API token body.", + "required":true, + "schema":{ + "$ref":"#/definitions/ApiToken" } } ], - "responses": { - "200": { - "description": "Success", - "schema": { - "$ref": "#/definitions/ApiToken" + "responses":{ + "200":{ + "description":"Success", + "schema":{ + "$ref":"#/definitions/ApiToken" } } } }, - "delete": { - "operationId": "ApiTokens_Remove", - "summary": "Delete an API token.", - "parameters": [ + "delete":{ + "operationId":"ApiTokens_Remove", + "summary":"Delete an API token.", + "parameters":[ { - "in": "path", - "name": "token_id", - "description": "Unique ID for the API token.", - "type": "string", - "required": true + "in":"path", + "name":"token_id", + "description":"Unique ID for the API token.", + "type":"string", + "required":true } ], - "x-ms-examples": { - "Delete API token": { - "$ref": "./examples/apitoken_delete.json" + "x-ms-examples":{ + "Delete API token":{ + "$ref":"./examples/apitoken_delete.json" } }, - "responses": { - "204": { - "description": "Success" + "responses":{ + "204":{ + "description":"Success" } } } }, - "/devices": { - "get": { - "operationId": "Devices_List", - "summary": "Get the list of devices in an application", - "x-ms-examples": { - "List devices": { - "$ref": "./examples/devices_list.json" - } - }, - "responses": { - "200": { - "description": "Success", - "schema": { - "$ref": "#/definitions/DeviceCollection" + "/continuousDataExports":{ + "get":{ + "operationId":"ContinuousDataExports_List", + "summary":"Get the list of continuous data exports in an application.", + "x-ms-examples":{ + "List exports":{ + "$ref":"./examples/continuousdataexports_list.json" + } + }, + "responses":{ + "200":{ + "description":"Success", + "schema":{ + "$ref":"#/definitions/ContinuousDataExportCollection" } } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" } } }, - "/devices/{device_id}": { - "get": { - "operationId": "Devices_Get", - "summary": "Get a device by ID", - "description": "Get details about an existing device by device ID.", - "parameters": [ - { - "$ref": "#/parameters/DeviceId" - } - ], - "x-ms-examples": { - "Get device by Id": { - "$ref": "./examples/devices_get.json" - } - }, - "responses": { - "200": { - "description": "Success", - "schema": { - "$ref": "#/definitions/Device" + "/continuousDataExports/{export_id}":{ + "parameters":[ + { + "in":"path", + "name":"export_id", + "description":"Unique ID for the continuous data export.", + "type":"string", + "required":true + } + ], + "get":{ + "operationId":"ContinuousDataExports_Get", + "summary":"Get a continuous data export by ID.", + "x-ms-examples":{ + "Get export":{ + "$ref":"./examples/continuousdataexports_get.json" + } + }, + "responses":{ + "200":{ + "description":"Success", + "schema":{ + "$ref":"#/definitions/ContinuousDataExport" } } } }, - "put": { - "operationId": "Devices_Set", - "summary": "Create or update a device", - "description": "Create a new device or update an existing one by device ID.", - "x-ms-examples": { - "Create device": { - "$ref": "./examples/devices_create.json" + "put":{ + "operationId":"ContinuousDataExports_Set", + "summary":"Create a new continuous data export or update an existing one by ID.", + "x-ms-examples":{ + "Create or update export":{ + "$ref":"./examples/continuousdataexports_set.json" } }, - "parameters": [ + "parameters":[ { - "$ref": "#/parameters/DeviceId" + "in":"path", + "name":"export_id", + "description":"Unique ID for the continuous data export.", + "type":"string", + "required":true }, { - "name": "body", - "in": "body", - "description": "Device body.", - "required": true, - "schema": { - "$ref": "#/definitions/Device" + "name":"body", + "in":"body", + "description":"Data export body.", + "required":true, + "schema":{ + "$ref":"#/definitions/ContinuousDataExport" } } ], - "responses": { - "200": { - "description": "Success", - "schema": { - "$ref": "#/definitions/Device" + "responses":{ + "200":{ + "description":"Success", + "schema":{ + "$ref":"#/definitions/ContinuousDataExport" } } } }, - "delete": { - "operationId": "Devices_Remove", - "summary": "Delete a device", - "description": "Delete an existing device by device ID.", - "parameters": [ + "delete":{ + "operationId":"ContinuousDataExports_Remove", + "summary":"Delete a continuous data export.", + "parameters":[ { - "$ref": "#/parameters/DeviceId" + "in":"path", + "name":"export_id", + "description":"Unique ID for the continuous data export.", + "type":"string", + "required":true } ], - "x-ms-examples": { - "Delete device": { - "$ref": "./examples/devices_delete.json" + "x-ms-examples":{ + "Delete export":{ + "$ref":"./examples/continuousdataexports_delete.json" } }, - "responses": { - "204": { - "description": "Success" + "responses":{ + "204":{ + "description":"Success" } } } }, - "/continuousDataExports": { - "get": { - "operationId": "ContinuousDataExports_List", - "summary": "Get the list of continuous data exports in an application.", - "x-ms-examples": { - "List exports": { - "$ref": "./examples/continuousdataexports_list.json" - } - }, - "responses": { - "200": { - "description": "Success", - "schema": { - "$ref": "#/definitions/ContinuousDataExportCollection" + "/deviceTemplates":{ + "get":{ + "operationId":"DeviceTemplates_List", + "summary":"Get the list of device templates in an application", + "x-ms-examples":{ + "List device templates":{ + "$ref":"./examples/devicetemplates_list.json" + } + }, + "responses":{ + "200":{ + "description":"Success", + "schema":{ + "$ref":"#/definitions/DeviceTemplateCollection" } } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" } } }, - "/continuousDataExports/{export_id}": { - "get": { - "operationId": "ContinuousDataExports_Get", - "summary": "Get a continuous data export by ID.", - "parameters": [ + "/deviceTemplates/{device_template_id}":{ + "get":{ + "operationId":"DeviceTemplates_Get", + "summary":"Get a device template by ID", + "parameters":[ + { + "$ref":"#/parameters/DeviceTemplateId" + } + ], + "x-ms-examples":{ + "Get a device template by Id":{ + "$ref":"./examples/devicetemplates_get.json" + } + }, + "responses":{ + "200":{ + "description":"Success", + "schema":{ + "$ref":"#/definitions/DeviceTemplate" + } + } + } + }, + "delete":{ + "operationId":"DeviceTemplates_Remove", + "summary":"Delete a device template", + "description":"Delete an existing device template by device ID.", + "parameters":[ { - "in": "path", - "name": "export_id", - "description": "Unique ID for the continuous data export.", - "type": "string", - "required": true + "$ref":"#/parameters/DeviceTemplateId" } ], - "x-ms-examples": { - "Get export": { - "$ref": "./examples/continuousdataexports_get.json" + "x-ms-examples":{ + "Delete a device template by Id":{ + "$ref":"./examples/devicetemplates_delete.json" } }, - "responses": { - "200": { - "description": "Success", - "schema": { - "$ref": "#/definitions/ContinuousDataExport" - } + "responses":{ + "204":{ + "description":"Success" } } }, - "put": { - "operationId": "ContinuousDataExports_Set", - "summary": "Create a new continuous data export or update an existing one by ID.", - "x-ms-examples": { - "Create or update export": { - "$ref": "./examples/continuousdataexports_set.json" + "put":{ + "operationId":"DeviceTemplates_Set", + "summary":"Create or update a device template", + "x-ms-examples":{ + "Create a device template":{ + "$ref":"./examples/devicetemplates_create.json" } }, - "parameters": [ + "parameters":[ { - "in": "path", - "name": "export_id", - "description": "Unique ID for the continuous data export.", - "type": "string", - "required": true + "$ref":"#/parameters/DeviceTemplateId" }, { - "name": "body", - "in": "body", - "description": "Data export body.", - "required": true, - "schema": { - "$ref": "#/definitions/ContinuousDataExport" + "name":"body", + "in":"body", + "description":"Device template body.", + "required":true, + "schema":{ + "$ref":"#/definitions/DeviceTemplate" } } ], - "responses": { - "200": { - "description": "Success", - "schema": { - "$ref": "#/definitions/ContinuousDataExport" + "responses":{ + "200":{ + "description":"Success", + "schema":{ + "$ref":"#/definitions/DeviceTemplate" } } } + } + }, + "/deviceTemplates/{device_template_id}/merged":{ + "get":{ + "operationId":"DeviceTemplates_GetMerged", + "summary":"Get a merged device template by ID", + "parameters":[ + { + "$ref":"#/parameters/DeviceTemplateId" + } + ], + "x-ms-examples":{ + "Get a merged device template by Id":{ + "$ref":"./examples/devicetemplates_get_merged.json" + } }, - "delete": { - "operationId": "ContinuousDataExports_Remove", - "summary": "Delete a continuous data export.", - "parameters": [ - { - "in": "path", - "name": "export_id", - "description": "Unique ID for the continuous data export.", - "type": "string", - "required": true - } - ], - "x-ms-examples": { - "Delete export": { - "$ref": "./examples/continuousdataexports_delete.json" - } - }, - "responses": { - "204": { - "description": "Success" + "responses":{ + "200":{ + "description":"Success", + "schema":{ + "$ref":"#/definitions/DeviceTemplate" + } } } } }, - "/deviceTemplates": { - "get": { - "operationId": "DeviceTemplates_List", - "summary": "Get the list of device templates in an application", - "x-ms-examples": { - "List device templates": { - "$ref": "./examples/devicetemplates_list.json" - } - }, - "responses": { - "200": { - "description": "Success", - "schema": { - "$ref": "#/definitions/DeviceTemplateCollection" + "/deviceTemplates/{device_template_id}/devices":{ + "get":{ + "operationId":"DeviceTemplates_ListDevices", + "summary":"Get devices for a template", + "parameters":[ + { + "$ref":"#/parameters/DeviceTemplateId" + } + ], + "x-ms-examples":{ + "List devices associated to a device template":{ + "$ref":"./examples/devices_list_by_template.json" + } + }, + "responses":{ + "200":{ + "description":"Success", + "schema":{ + "$ref":"#/definitions/DeviceCollection" } } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" } } }, - "/deviceTemplates/{device_template_id}": { - "get": { - "operationId": "DeviceTemplates_Get", - "summary": "Get a device template by ID", - "parameters": [ - { - "$ref": "#/parameters/DeviceTemplateId" - } - ], - "x-ms-examples": { - "Get a device template by Id": { - "$ref": "./examples/devicetemplates_get.json" - } - }, - "responses": { - "200": { - "description": "Success", - "schema": { - "$ref": "#/definitions/DeviceTemplate" + "/devices":{ + "get":{ + "operationId":"Devices_List", + "summary":"Get the list of devices in an application", + "x-ms-examples":{ + "List devices":{ + "$ref":"./examples/devices_list.json" + } + }, + "responses":{ + "200":{ + "description":"Success", + "schema":{ + "$ref":"#/definitions/DeviceCollection" } } } + } + }, + "/devices/{device_id}":{ + "get":{ + "operationId":"Devices_Get", + "summary":"Get a device by ID", + "description":"Get details about an existing device by device ID.", + "parameters":[ + { + "$ref":"#/parameters/DeviceId" + } + ], + "x-ms-examples":{ + "Get device by Id":{ + "$ref":"./examples/devices_get.json" + } }, - "delete": { - "operationId": "DeviceTemplates_Remove", - "summary": "Delete a device template", - "description": "Delete an existing device template by device ID.", - "parameters": [ - { - "$ref": "#/parameters/DeviceTemplateId" - } - ], - "x-ms-examples": { - "Delete a device template by Id": { - "$ref": "./examples/devicetemplates_delete.json" - } - }, - "responses": { - "204": { - "description": "Success" + "responses":{ + "200":{ + "description":"Success", + "schema":{ + "$ref":"#/definitions/Device" + } } } }, - "put": { - "operationId": "DeviceTemplates_Set", - "summary": "Create or update a device template by ID", - "x-ms-examples": { - "Create a device template": { - "$ref": "./examples/devicetemplates_create.json" + "put":{ + "operationId":"Devices_Set", + "summary":"Create or update a device", + "description":"Create a new device or update an existing one by device ID.", + "x-ms-examples":{ + "Create device":{ + "$ref":"./examples/devices_create.json" } }, - "parameters": [ + "parameters":[ { - "$ref": "#/parameters/DeviceTemplateId" + "$ref":"#/parameters/DeviceId" }, { - "name": "body", - "in": "body", - "description": "Device template body.", - "required": true, - "schema": { - "$ref": "#/definitions/DeviceTemplate" + "name":"body", + "in":"body", + "description":"Device body.", + "required":true, + "schema":{ + "$ref":"#/definitions/Device" } } ], - "responses": { - "200": { - "description": "Success", - "schema": { - "$ref": "#/definitions/DeviceTemplate" + "responses":{ + "200":{ + "description":"Success", + "schema":{ + "$ref":"#/definitions/Device" } } } - } - }, - "/deviceTemplates/{device_template_id}/merged": { - "get": { - "operationId": "DeviceTemplates_GetMerged", - "summary": "Get a merged device template by ID", - "parameters": [ + }, + "delete":{ + "operationId":"Devices_Remove", + "summary":"Delete a device", + "description":"Delete an existing device by device ID.", + "parameters":[ { - "$ref": "#/parameters/DeviceTemplateId" + "$ref":"#/parameters/DeviceId" } ], - "x-ms-examples": { - "Get a merged device template by Id": { - "$ref": "./examples/devicetemplates_get_merged.json" + "x-ms-examples":{ + "Delete device":{ + "$ref":"./examples/devices_delete.json" } }, - "responses": { - "200": { - "description": "Success", - "schema": { - "$ref": "#/definitions/DeviceTemplate" - } + "responses":{ + "204":{ + "description":"Success" } } } }, - "/deviceTemplates/{device_template_id}/devices": { - "get": { - "operationId": "DeviceTemplates_ListDevices", - "summary": "Get devices for a template", - "parameters": [ - { - "$ref": "#/parameters/DeviceTemplateId" - } - ], - "x-ms-examples": { - "List devices associated to a device template": { - "$ref": "./examples/devices_list_by_template.json" - } - }, - "responses": { - "200": { - "description": "Success", - "schema": { - "$ref": "#/definitions/DeviceCollection" + "/roles":{ + "get":{ + "operationId":"Roles_List", + "summary":"Get the list of roles in an application.", + "x-ms-examples":{ + "List roles":{ + "$ref":"./examples/roles_list.json" + } + }, + "responses":{ + "200":{ + "description":"Success", + "schema":{ + "$ref":"#/definitions/RoleCollection" } } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" } } }, - "/roles": { - "get": { - "operationId": "Roles_List", - "summary": "Get the list of roles in an application.", - "x-ms-examples": { - "List roles": { - "$ref": "./examples/roles_list.json" - } - }, - "responses": { - "200": { - "description": "Success", - "schema": { - "$ref": "#/definitions/RoleCollection" + "/roles/{role_id}":{ + "get":{ + "operationId":"Roles_Get", + "summary":"Get a role by ID.", + "parameters":[ + { + "in":"path", + "name":"role_id", + "description":"Unique ID for the role.", + "type":"string", + "required":true + } + ], + "x-ms-examples":{ + "Get role by Id":{ + "$ref":"./examples/roles_get.json" + } + }, + "responses":{ + "200":{ + "description":"Success", + "schema":{ + "$ref":"#/definitions/Role" } } - }, - "x-ms-pageable": { - "nextLinkName": null } } }, - "/roles/{role_id}": { - "get": { - "operationId": "Roles_Get", - "summary": "Get a role by ID.", - "parameters": [ + "/devices/{device_id}/attestation":{ + "parameters":[ + { + "$ref":"#/parameters/DeviceId" + } + ], + "get":{ + "operationId":"Devices_GetAttestation", + "summary":"Get device attestation", + "x-ms-examples":{ + "Get device attestation":{ + "$ref":"./examples/devices_attestations_get.json" + } + }, + "responses":{ + "200":{ + "description":"Success", + "schema":{ + "$ref":"#/definitions/Attestation" + } + } + } + }, + "put":{ + "operationId":"Devices_SetAttestation", + "summary":"Create or update an individual device attestation", + "parameters":[ + { + "$ref":"#/parameters/DeviceId" + }, { - "in": "path", - "name": "role_id", - "description": "Unique ID for the role.", - "type": "string", - "required": true + "name":"body", + "in":"body", + "description":"Individual device attestation body.", + "required":true, + "schema":{ + "$ref":"#/definitions/Attestation" + } } ], - "x-ms-examples": { - "Get role by Id": { - "$ref": "./examples/roles_get.json" + "x-ms-examples":{ + "Create or update device attestation":{ + "$ref":"./examples/devices_attestations_set.json" } }, - "responses": { - "200": { - "description": "Success", - "schema": { - "$ref": "#/definitions/Role" + "responses":{ + "200":{ + "description":"Success", + "schema":{ + "$ref":"#/definitions/Attestation" } } } - } - }, - "/devices/{device_id}/cloudProperties": { - "get": { - "operationId": "Devices_GetCloudProperties", - "summary": "Get device cloud properties", - "description": "Get all cloud property values of a device by device ID.", - "parameters": [ + }, + "delete":{ + "operationId":"Devices_RemoveAttestation", + "summary":"Remove an individual device attestation", + "parameters":[ { - "$ref": "#/parameters/DeviceId" + "$ref":"#/parameters/DeviceId" } ], - "x-ms-examples": { - "Get cloud properties": { - "$ref": "./examples/devices_cloudproperties_get.json" + "x-ms-examples":{ + "Delete device attestation":{ + "$ref":"./examples/devices_attestations_delete.json" } }, - "responses": { - "200": { - "description": "Success", - "schema": { - "$ref": "#/definitions/DeviceCloudProperties" + "responses":{ + "204":{ + "description":"Success" + } + } + } + }, + "/devices/{device_id}/cloudProperties":{ + "parameters":[ + { + "$ref":"#/parameters/DeviceId" + } + ], + "get":{ + "operationId":"Devices_GetCloudProperties", + "summary":"Get device cloud properties", + "description":"Get all cloud property values of a device by device ID.", + "x-ms-examples":{ + "Get cloud properties":{ + "$ref":"./examples/devices_cloudproperties_get.json" + } + }, + "responses":{ + "200":{ + "description":"Success", + "schema":{ + "$ref":"#/definitions/DeviceCloudProperties" } } } }, - "put": { - "operationId": "Devices_UpdateCloudProperties", - "summary": "Update device cloud properties", - "description": "Update all cloud property values of a device by device ID.", - "x-ms-examples": { - "Update cloud properties": { - "$ref": "./examples/devices_cloudproperties_update.json" + "put":{ + "operationId":"Devices_UpdateCloudProperties", + "summary":"Update device cloud properties", + "description":"Update all cloud property values of a device by device ID.", + "x-ms-examples":{ + "Update cloud properties":{ + "$ref":"./examples/devices_cloudproperties_update.json" } }, - "parameters": [ + "parameters":[ { - "$ref": "#/parameters/DeviceId" - }, - { - "name": "body", - "in": "body", - "description": "Device properties.", - "required": true, - "schema": { - "$ref": "#/definitions/DeviceCloudProperties" + "name":"body", + "in":"body", + "description":"Device properties.", + "required":true, + "schema":{ + "$ref":"#/definitions/DeviceCloudProperties" } } ], - "responses": { - "200": { - "description": "Success", - "schema": { - "$ref": "#/definitions/DeviceCloudProperties" + "responses":{ + "200":{ + "description":"Success", + "schema":{ + "$ref":"#/definitions/DeviceCloudProperties" } } } } }, - "/devices/{device_id}/components/{component_name}/commands/{command_name}": { - "get": { - "operationId": "Devices_GetCommandHistory", - "summary": "Get device command history", - "parameters": [ - { - "$ref": "#/parameters/DeviceId" - }, - { - "$ref": "#/parameters/ComponentName" - }, - { - "in": "path", - "name": "command_name", - "description": "Name of this device command.", - "x-ms-parameter-location": "method", - "type": "string", - "required": true - } - ], - "x-ms-examples": { - "Get command history": { - "$ref": "./examples/devices_commandshistory_get.json" - } + "/devices/{device_id}/components/{component_name}/commands/{command_name}":{ + "parameters":[ + { + "$ref":"#/parameters/DeviceId" }, - "responses": { - "200": { - "description": "Success", - "schema": { - "$ref": "#/definitions/DeviceCommandCollection" + { + "$ref":"#/parameters/ComponentName" + }, + { + "in":"path", + "name":"command_name", + "description":"Name of this device command.", + "type":"string", + "required":true + } + ], + "get":{ + "operationId":"Devices_GetCommandHistory", + "summary":"Get device command history", + "x-ms-examples":{ + "Get command history":{ + "$ref":"./examples/devices_commandshistory_get.json" + } + }, + "responses":{ + "200":{ + "description":"Success", + "schema":{ + "$ref":"#/definitions/DeviceCommandCollection" } } - }, - "x-ms-pageable": { - "nextLinkName": null } }, - "post": { - "operationId": "Devices_ExecuteCommand", - "summary": "Execute a device command", - "description": "Execute a command on a device.", - "x-ms-examples": { - "Send command": { - "$ref": "./examples/devices_commands_send.json" + "post":{ + "operationId":"Devices_ExecuteCommand", + "summary":"Execute a device command", + "description":"Execute a command on a device.", + "x-ms-examples":{ + "Send command":{ + "$ref":"./examples/devices_commands_send.json" } }, - "parameters": [ - { - "$ref": "#/parameters/DeviceId" - }, + "parameters":[ { - "$ref": "#/parameters/ComponentName" - }, - { - "in": "path", - "name": "command_name", - "description": "Name of this device command.", - "x-ms-parameter-location": "method", - "type": "string", - "required": true - }, - { - "name": "body", - "in": "body", - "description": "Device command body.", - "required": true, - "schema": { - "$ref": "#/definitions/DeviceCommand" + "name":"body", + "in":"body", + "description":"Device command body.", + "required":true, + "schema":{ + "$ref":"#/definitions/DeviceCommand" } } ], - "responses": { - "201": { - "description": "Success", - "schema": { - "$ref": "#/definitions/DeviceCommand" + "responses":{ + "201":{ + "description":"Success", + "schema":{ + "$ref":"#/definitions/DeviceCommand" } } } } }, - "/devices/{device_id}/properties": { - "get": { - "operationId": "Devices_GetProperties", - "summary": "Get device properties", - "description": "Get all property values of a device by device ID.", - "parameters": [ - { - "$ref": "#/parameters/DeviceId" - } - ], - "x-ms-examples": { - "Get properties": { - "$ref": "./examples/devices_properties_get.json" + "/devices/{device_id}/credentials":{ + "parameters":[ + { + "$ref":"#/parameters/DeviceId" + } + ], + "get":{ + "operationId":"Devices_GetCredentials", + "summary":"Get device credentials", + "x-ms-examples":{ + "Get device credentials":{ + "$ref":"./examples/devicecredentials_get.json" + } + }, + "responses":{ + "200":{ + "description":"Success", + "schema":{ + "$ref":"#/definitions/DeviceCredentials" + } } - }, - "responses": { - "200": { - "description": "Success", - "schema": { - "$ref": "#/definitions/DeviceProperties" + } + } + }, + "/devices/{device_id}/properties":{ + "parameters":[ + { + "$ref":"#/parameters/DeviceId" + } + ], + "get":{ + "operationId":"Devices_GetProperties", + "summary":"Get device properties", + "description":"Get all property values of a device by device ID.", + "responses":{ + "200":{ + "description":"Success", + "schema":{ + "$ref":"#/definitions/DeviceProperties" } } } }, - "put": { - "operationId": "Devices_UpdateProperties", - "summary": "Update device properties", - "description": "Update all property values of a device by device ID.", - "x-ms-examples": { - "Update properties": { - "$ref": "./examples/devices_properties_update.json" + "put":{ + "operationId":"Devices_UpdateProperties", + "summary":"Update device properties", + "description":"Update all property values of a device by device ID.", + "x-ms-examples":{ + "Update properties":{ + "$ref":"./examples/devices_properties_update.json" } }, - "parameters": [ - { - "$ref": "#/parameters/DeviceId" - }, + "parameters":[ { - "name": "body", - "in": "body", - "description": "Device properties.", - "required": true, - "schema": { - "$ref": "#/definitions/DeviceProperties" + "name":"body", + "in":"body", + "description":"Device properties.", + "required":true, + "schema":{ + "$ref":"#/definitions/DeviceProperties" } } ], - "responses": { - "202": { - "description": "Success", - "schema": { - "$ref": "#/definitions/DeviceProperties" + "responses":{ + "202":{ + "description":"Success", + "schema":{ + "$ref":"#/definitions/DeviceProperties" } } } } }, - "/devices/{device_id}/components/{component_name}/properties": { - "get": { - "operationId": "Devices_GetComponentProperties", - "summary": "Get device properties for a specific component", - "parameters": [ - { - "$ref": "#/parameters/DeviceId" - }, - { - "$ref": "#/parameters/ComponentName" - } - ], - "x-ms-examples": { - "Get properties on components": { - "$ref": "./examples/devices_properties_components_get.json" - } + "/devices/{device_id}/components/{component_name}/properties":{ + "parameters":[ + { + "$ref":"#/parameters/DeviceId" }, - "responses": { - "200": { - "description": "Success", - "schema": { - "$ref": "#/definitions/DeviceProperties" + { + "$ref":"#/parameters/ComponentName" + } + ], + "get":{ + "operationId":"Devices_GetComponentProperties", + "summary":"Get device properties for a specific component", + "x-ms-examples":{ + "Get properties on components":{ + "$ref":"./examples/devices_properties_components_get.json" + } + }, + "responses":{ + "200":{ + "description":"Success", + "schema":{ + "$ref":"#/definitions/DeviceProperties" } } } }, - "put": { - "operationId": "Devices_UpdateComponentProperties", - "summary": "Update device properties for a specific component", - "x-ms-examples": { - "Update properties on components": { - "$ref": "./examples/devices_properties_components_set.json" + "put":{ + "operationId":"Devices_UpdateComponentProperties", + "summary":"Update device properties for a specific component", + "x-ms-examples":{ + "Update properties on components":{ + "$ref":"./examples/devices_properties_components_set.json" } }, - "parameters": [ + "parameters":[ { - "$ref": "#/parameters/DeviceId" - }, - { - "$ref": "#/parameters/ComponentName" - }, - { - "name": "body", - "in": "body", - "description": "Device properties.", - "required": true, - "schema": { - "$ref": "#/definitions/DeviceProperties" + "name":"body", + "in":"body", + "description":"Device properties.", + "required":true, + "schema":{ + "$ref":"#/definitions/DeviceProperties" } } ], - "responses": { - "202": { - "description": "Success", - "schema": { - "$ref": "#/definitions/DeviceProperties" + "responses":{ + "202":{ + "description":"Success", + "schema":{ + "$ref":"#/definitions/DeviceProperties" } } } } }, - "/devices/{device_id}/credentials": { - "get": { - "operationId": "Devices_GetCredentials", - "summary": "Get device credentials", - "parameters": [ - { - "$ref": "#/parameters/DeviceId" - } - ], - "x-ms-examples": { - "Get device credentials": { - "$ref": "./examples/devicecredentials_get.json" - } + "/devices/{device_id}/components/{component_name}/telemetry/{telemetry_name}":{ + "parameters":[ + { + "$ref":"#/parameters/DeviceId" }, - "responses": { - "200": { - "description": "Success", - "schema": { - "$ref": "#/definitions/DeviceCredentials" - } - } - } - } - }, - "/devices/{device_id}/components/{component_name}/telemetry/{telemetry_name}": { - "get": { - "operationId": "Devices_GetTelemetryValue", - "summary": "Get device telemetry value", - "parameters": [ - { - "$ref": "#/parameters/DeviceId" - }, - { - "$ref": "#/parameters/ComponentName" - }, - { - "in": "path", - "name": "telemetry_name", - "description": "Name of this device telemetry.", - "x-ms-parameter-location": "method", - "type": "string", - "required": true - } - ], - "x-ms-examples": { - "Get telemetry": { - "$ref": "./examples/devices_telemetry_get.json" - } + { + "$ref":"#/parameters/ComponentName" }, - "responses": { - "200": { - "description": "Success", - "schema": { - "$ref": "#/definitions/Value" + { + "in":"path", + "name":"telemetry_name", + "description":"Name of this device telemetry.", + "type":"string", + "required":true + } + ], + "get":{ + "operationId":"Devices_GetTelemetryValue", + "summary":"Get device telemetry value", + "x-ms-examples":{ + "Get telemetry":{ + "$ref":"./examples/devices_telemetry_get.json" + } + }, + "responses":{ + "200":{ + "description":"Success", + "schema":{ + "$ref":"#/definitions/DeviceTelemetry" } } } } - } - }, - "parameters": { - "DeviceId": { - "in": "path", - "name": "device_id", - "description": "Unique ID of the device.", - "x-ms-parameter-location": "method", - "type": "string", - "required": true - }, - "ComponentName": { - "in": "path", - "name": "component_name", - "description": "Name of the device component.", - "x-ms-parameter-location": "method", - "type": "string", - "required": true - }, - "DeviceTemplateId": { - "in": "path", - "name": "device_template_id", - "description": "Unique ID of the device template.", - "x-ms-parameter-location": "method", - "type": "string", - "required": true - }, - "Subdomain": { - "in": "path", - "name": "subdomain", - "description": "Application subdomain.", - "x-ms-parameter-location": "client", - "type": "string", - "required": true - }, - "CentralDnsSuffixInPath": { - "name": "centralDnsSuffixInPath", - "in": "path", - "required": true, - "type": "string", - "default": "azureiotcentral.com", - "x-ms-skip-url-encoding": true, - "description": "The DNS suffix used as the base for all Azure IoT Central service requests.", - "x-ms-parameter-location": "client" - } - }, - "securityDefinitions": { - "azure_auth": { - "type": "oauth2", - "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", - "flow": "implicit", - "description": "Azure Active Directory OAuth2 Flow", - "scopes": { - "user_impersonation": "impersonate your user account" } - } - }, - "x-ms-parameterized-host": { - "hostTemplate": "{subdomain}.{centralDnsSuffixInPath}", - "parameters": [ - { - "$ref": "#/parameters/Subdomain" + }, + "parameters":{ + "DeviceTemplateId":{ + "in":"path", + "name":"device_template_id", + "description":"Unique ID of the device template.", + "type":"string", + "required":true + }, + "DeviceId":{ + "in":"path", + "name":"device_id", + "description":"Unique ID of the device.", + "type":"string", + "required":true + }, + "ComponentName":{ + "in":"path", + "name":"component_name", + "description":"Name of the device component.", + "type":"string", + "required":true + }, + "Subdomain":{ + "in":"path", + "name":"subdomain", + "description":"Application subdomain.", + "x-ms-parameter-location":"client", + "type":"string", + "required":true }, - { - "$ref": "#/parameters/CentralDnsSuffixInPath" + "CentralDnsSuffixInPath":{ + "name":"centralDnsSuffixInPath", + "in":"path", + "required":true, + "type":"string", + "default":"azureiotcentral.com", + "x-ms-skip-url-encoding":true, + "description":"The DNS suffix used as the base for all Azure IoT Central service requests.", + "x-ms-parameter-location":"client" } - ] - } -} + }, + "securityDefinitions":{ + "azure_auth":{ + "type":"oauth2", + "authorizationUrl":"https://login.microsoftonline.com/common/oauth2/authorize", + "flow":"implicit", + "description":"Azure Active Directory OAuth2 Flow", + "scopes":{ + "user_impersonation":"impersonate your user account" + } + } + }, + "x-ms-parameterized-host":{ + "hostTemplate":"{subdomain}.{centralDnsSuffixInPath}", + "parameters":[ + { + "$ref":"#/parameters/Subdomain" + }, + { + "$ref":"#/parameters/CentralDnsSuffixInPath" + } + ] + } + } \ No newline at end of file From d4e553059f01b5de34ea28052f516efdd2b078ff Mon Sep 17 00:00:00 2001 From: Vivian Liu Date: Fri, 28 Feb 2020 16:02:28 -0800 Subject: [PATCH 2/8] fixing swagger --- .../preview/2019-10-28-preview/iotcentral.json | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/specification/iotcentral/data-plane/Microsoft.IoTCentral/preview/2019-10-28-preview/iotcentral.json b/specification/iotcentral/data-plane/Microsoft.IoTCentral/preview/2019-10-28-preview/iotcentral.json index de7e883a624c..8f750e62008b 100644 --- a/specification/iotcentral/data-plane/Microsoft.IoTCentral/preview/2019-10-28-preview/iotcentral.json +++ b/specification/iotcentral/data-plane/Microsoft.IoTCentral/preview/2019-10-28-preview/iotcentral.json @@ -1622,6 +1622,7 @@ "in":"path", "name":"command_name", "description":"Name of this device command.", + "x-ms-parameter-location": "method", "type":"string", "required":true } @@ -1707,6 +1708,11 @@ "operationId":"Devices_GetProperties", "summary":"Get device properties", "description":"Get all property values of a device by device ID.", + "x-ms-examples":{ + "Update properties":{ + "$ref":"./examples/devices_properties_get.json" + } + }, "responses":{ "200":{ "description":"Success", @@ -1813,6 +1819,7 @@ "in":"path", "name":"telemetry_name", "description":"Name of this device telemetry.", + "x-ms-parameter-location": "method", "type":"string", "required":true } @@ -1841,6 +1848,7 @@ "in":"path", "name":"device_template_id", "description":"Unique ID of the device template.", + "x-ms-parameter-location": "method", "type":"string", "required":true }, @@ -1848,6 +1856,7 @@ "in":"path", "name":"device_id", "description":"Unique ID of the device.", + "x-ms-parameter-location": "method", "type":"string", "required":true }, @@ -1855,6 +1864,7 @@ "in":"path", "name":"component_name", "description":"Name of the device component.", + "x-ms-parameter-location": "method", "type":"string", "required":true }, From a8d6b46dbaabcbe2bae633bc9335079407b2f110 Mon Sep 17 00:00:00 2001 From: Vivian Liu Date: Fri, 28 Feb 2020 16:17:53 -0800 Subject: [PATCH 3/8] Making small tweaks --- package-lock.json | 6 +++--- package.json | 6 +++--- .../2019-10-28-preview/examples/devicecredentials_get.json | 2 +- .../examples/devices_attestations_delete.json | 3 ++- .../preview/2019-10-28-preview/iotcentral.json | 2 +- 5 files changed, 10 insertions(+), 9 deletions(-) diff --git a/package-lock.json b/package-lock.json index 9bb5d920da32..2d6a62221bf6 100644 --- a/package-lock.json +++ b/package-lock.json @@ -4189,9 +4189,9 @@ "dev": true }, "prettier": { - "version": "1.18.2", - "resolved": "https://registry.npmjs.org/prettier/-/prettier-1.18.2.tgz", - "integrity": "sha512-OeHeMc0JhFE9idD4ZdtNibzY0+TPHSpSSb9h8FqtP+YnoZZ1sl8Vc9b1sasjfymH3SonAF4QcA2+mzHPhMvIiw==", + "version": "1.19.1", + "resolved": "https://registry.npmjs.org/prettier/-/prettier-1.19.1.tgz", + "integrity": "sha512-s7PoyDv/II1ObgQunCbB9PdLmUcBZcnWOcxDh7O0N/UwDEsHyqkW+Qh28jW+mVuCdx7gLB0BotYI1Y6uI9iyew==", "dev": true }, "process-nextick-args": { diff --git a/package.json b/package.json index 682934dbd6ed..724c10c7ed5d 100644 --- a/package.json +++ b/package.json @@ -10,7 +10,6 @@ "description": "Tests for Azure REST API Specifications", "license": "MIT", "devDependencies": { - "@types/prettier": "^1.18.3", "@azure/avocado": "^0.6.2", "@azure/rest-api-specs-scripts": "^0.5.7", "@ts-common/commonmark-to-markdown": "^1.2.0", @@ -18,14 +17,15 @@ "@ts-common/iterator": "^0.3.6", "@types/js-yaml": "^3.12.1", "@types/mocha": "^5.2.6", + "@types/prettier": "^1.18.3", "cspell": "^4.0.30", "js-yaml": "^3.13.1", "json-schema-ref-parser": "^6.1.0", "mocha": "*", + "prettier": "^1.19.1", "ts-node": "^8.1.0", "tslib": "^1.10.0", - "typescript": "3.5.3", - "prettier": "^1.18.2" + "typescript": "3.5.3" }, "homepage": "https://github.com/azure/azure-rest-api-specs", "repository": { diff --git a/specification/iotcentral/data-plane/Microsoft.IoTCentral/preview/2019-10-28-preview/examples/devicecredentials_get.json b/specification/iotcentral/data-plane/Microsoft.IoTCentral/preview/2019-10-28-preview/examples/devicecredentials_get.json index e1112eba7214..451ef32d72c5 100644 --- a/specification/iotcentral/data-plane/Microsoft.IoTCentral/preview/2019-10-28-preview/examples/devicecredentials_get.json +++ b/specification/iotcentral/data-plane/Microsoft.IoTCentral/preview/2019-10-28-preview/examples/devicecredentials_get.json @@ -9,7 +9,7 @@ "responses": { "200": { "body": { - "scopeId": "0ne0005F266", + "idScope": "0ne0005F266", "symmetricKey": { "primaryKey": "XaMfV3vryCQw963L2IALf1SdApQRzSIBQd13/fassqM=", "secondaryKey": "s+4uT31TRZJcTSGxZUPZb1yznjTicu4jr9tXNrg+xIQ=" diff --git a/specification/iotcentral/data-plane/Microsoft.IoTCentral/preview/2019-10-28-preview/examples/devices_attestations_delete.json b/specification/iotcentral/data-plane/Microsoft.IoTCentral/preview/2019-10-28-preview/examples/devices_attestations_delete.json index ccef956aeb41..849e3a8acda5 100644 --- a/specification/iotcentral/data-plane/Microsoft.IoTCentral/preview/2019-10-28-preview/examples/devices_attestations_delete.json +++ b/specification/iotcentral/data-plane/Microsoft.IoTCentral/preview/2019-10-28-preview/examples/devices_attestations_delete.json @@ -3,7 +3,8 @@ "description": "Deletes the attestation for a device.", "parameters": { "centralDnsSuffixInPath": "azureiotcentral.com", - "subdomain": "appsubdomain" + "subdomain": "appsubdomain", + "device_id": "Checkout4" }, "responses": { "204": {} diff --git a/specification/iotcentral/data-plane/Microsoft.IoTCentral/preview/2019-10-28-preview/iotcentral.json b/specification/iotcentral/data-plane/Microsoft.IoTCentral/preview/2019-10-28-preview/iotcentral.json index 8f750e62008b..01a4fdce2146 100644 --- a/specification/iotcentral/data-plane/Microsoft.IoTCentral/preview/2019-10-28-preview/iotcentral.json +++ b/specification/iotcentral/data-plane/Microsoft.IoTCentral/preview/2019-10-28-preview/iotcentral.json @@ -958,7 +958,7 @@ "type":"integer" }, "trimWhitespace":{ - "description":"Specifies the visual and storage treatment of whitespaces in the string.", + "description":"Specifies the visual and storage treatment of white spaces in the string.", "type":"boolean" } } From 3c82aed9c53592f721b3046b855b0fc7b985ed22 Mon Sep 17 00:00:00 2001 From: Vivian Liu Date: Fri, 28 Feb 2020 16:29:07 -0800 Subject: [PATCH 4/8] Removed solution model in example --- .../examples/devicetemplates_create.json | 102 ------------------ 1 file changed, 102 deletions(-) diff --git a/specification/iotcentral/data-plane/Microsoft.IoTCentral/preview/2019-10-28-preview/examples/devicetemplates_create.json b/specification/iotcentral/data-plane/Microsoft.IoTCentral/preview/2019-10-28-preview/examples/devicetemplates_create.json index a5ca1e93dfa9..5013639058c3 100644 --- a/specification/iotcentral/data-plane/Microsoft.IoTCentral/preview/2019-10-28-preview/examples/devicetemplates_create.json +++ b/specification/iotcentral/data-plane/Microsoft.IoTCentral/preview/2019-10-28-preview/examples/devicetemplates_create.json @@ -70,56 +70,6 @@ "@context": [ "http://azureiot.com/v1/contexts/IoTModel.json" ] - }, - "solutionModel": { - "@id": "urn:1dsfbt7i:modelDefinition:zadjfmgvh", - "@type": [ - "SolutionModel" - ], - "cloudProperties": [ - { - "@id": "urn:1dsfbt7i:modelDefinition:AssetId", - "@type": [ - "CloudProperty" - ], - "displayName": "Asset Id", - "name": "AssetId", - "schema": "string", - "valueDetail": { - "@id": "urn:1dsfbt7i:modelDefinition:AssetId:valueDetail", - "@type": [ - "ValueDetail/StringValueDetail" - ] - } - } - ], - "initialValues": [], - "overrides": [ - { - "@id": "urn:1dsfbt7i:modelDefinition:1qehkys5", - "@type": [ - "Override" - ], - "capability": { - "@type": [ - "CapabilityReference" - ], - "component": "urn:storeAnalyticsCheckoutPnp:capabilityModel:fyy5xn_y:1", - "reference": "urn:storeAnalyticsCheckoutPnp:Interface:Occupancy:1" - }, - "valueDetail": { - "@type": [ - "ValueDetail/NumberValueDetail" - ], - "maxValue": { - "@value": "50" - }, - "minValue": { - "@value": "0" - } - } - } - ] } } }, @@ -191,58 +141,6 @@ "@context": [ "http://azureiot.com/v1/contexts/IoTModel.json" ] - }, - "solutionModel": { - "@id": "urn:1dsfbt7i:modelDefinition:zadjfmgvh", - "@type": [ - "SolutionModel" - ], - "cloudProperties": [ - { - "@id": "urn:1dsfbt7i:modelDefinition:AssetId", - "@type": [ - "CloudProperty" - ], - "displayName": "Asset Id", - "name": "AssetId", - "schema": "string", - "valueDetail": { - "@id": "urn:1dsfbt7i:modelDefinition:AssetId:valueDetail", - "@type": [ - "ValueDetail/StringValueDetail" - ] - } - } - ], - "initialValues": [], - "overrides": [ - { - "@id": "urn:1dsfbt7i:modelDefinition:1qehkys5", - "@type": [ - "Override" - ], - "capability": { - "@id": "urn:1dsfbt7i:modelDefinition:1qehkys5:6wq2v5i7j", - "@type": [ - "CapabilityReference" - ], - "component": "urn:storeAnalyticsCheckoutPnp:capabilityModel:fyy5xn_y:1", - "reference": "urn:storeAnalyticsCheckoutPnp:Interface:Occupancy:1" - }, - "valueDetail": { - "@id": "urn:1dsfbt7i:modelDefinition:1qehkys5:_covclwk_", - "@type": [ - "ValueDetail/NumberValueDetail" - ], - "maxValue": { - "@value": "50" - }, - "minValue": { - "@value": "0" - } - } - } - ] } } } From 844d88a2b8d7f22ebfc1f0350b581090561866c2 Mon Sep 17 00:00:00 2001 From: Vivian Liu Date: Mon, 2 Mar 2020 09:33:41 -0800 Subject: [PATCH 5/8] Prettier check --- .../examples/devices_attestations_get.json | 12 +- .../examples/devices_attestations_set.json | 20 +- .../2019-10-28-preview/iotcentral.json | 2488 ++++++++--------- 3 files changed, 1260 insertions(+), 1260 deletions(-) diff --git a/specification/iotcentral/data-plane/Microsoft.IoTCentral/preview/2019-10-28-preview/examples/devices_attestations_get.json b/specification/iotcentral/data-plane/Microsoft.IoTCentral/preview/2019-10-28-preview/examples/devices_attestations_get.json index da001f1ca9cb..87efc9c7b2d3 100644 --- a/specification/iotcentral/data-plane/Microsoft.IoTCentral/preview/2019-10-28-preview/examples/devices_attestations_get.json +++ b/specification/iotcentral/data-plane/Microsoft.IoTCentral/preview/2019-10-28-preview/examples/devices_attestations_get.json @@ -11,13 +11,13 @@ "body": { "type": "X509Attestation", "x509": { - "clientCertificates": { - "primary": { - "info": { - "sha1Thumbprint": "" - } - } + "clientCertificates": { + "primary": { + "info": { + "sha1Thumbprint": "" + } } + } } } } diff --git a/specification/iotcentral/data-plane/Microsoft.IoTCentral/preview/2019-10-28-preview/examples/devices_attestations_set.json b/specification/iotcentral/data-plane/Microsoft.IoTCentral/preview/2019-10-28-preview/examples/devices_attestations_set.json index b38f3195d2bd..e86eff41a42d 100644 --- a/specification/iotcentral/data-plane/Microsoft.IoTCentral/preview/2019-10-28-preview/examples/devices_attestations_set.json +++ b/specification/iotcentral/data-plane/Microsoft.IoTCentral/preview/2019-10-28-preview/examples/devices_attestations_set.json @@ -8,11 +8,11 @@ "body": { "type": "X509Attestation", "x509": { - "clientCertificates": { - "primary": { - "certificate": "" - } + "clientCertificates": { + "primary": { + "certificate": "" } + } } } }, @@ -21,13 +21,13 @@ "body": { "type": "X509Attestation", "x509": { - "clientCertificates": { - "primary": { - "info": { - "sha1Thumbprint": "" - } - } + "clientCertificates": { + "primary": { + "info": { + "sha1Thumbprint": "" + } } + } } } } diff --git a/specification/iotcentral/data-plane/Microsoft.IoTCentral/preview/2019-10-28-preview/iotcentral.json b/specification/iotcentral/data-plane/Microsoft.IoTCentral/preview/2019-10-28-preview/iotcentral.json index 01a4fdce2146..4d991e7e22eb 100644 --- a/specification/iotcentral/data-plane/Microsoft.IoTCentral/preview/2019-10-28-preview/iotcentral.json +++ b/specification/iotcentral/data-plane/Microsoft.IoTCentral/preview/2019-10-28-preview/iotcentral.json @@ -1,927 +1,927 @@ { - "swagger":"2.0", - "info":{ - "version":"preview", - "title":"Azure IoT Central", - "description":"Azure IoT Central is a service that makes it easy to connect, monitor, and manage your IoT devices at scale." + "swagger": "2.0", + "info": { + "version": "preview", + "title": "Azure IoT Central", + "description": "Azure IoT Central is a service that makes it easy to connect, monitor, and manage your IoT devices at scale." }, - "basePath":"/api/preview", - "schemes":[ + "basePath": "/api/preview", + "schemes": [ "https" ], - "consumes":[ + "consumes": [ "application/json" ], - "produces":[ + "produces": [ "application/json" ], - "definitions":{ - "ApiToken":{ - "allOf":[ + "definitions": { + "ApiToken": { + "allOf": [ { - "$ref":"#/definitions/Permission" + "$ref": "#/definitions/Permission" }, { - "type":"object", - "properties":{ - "id":{ - "description":"Unique ID of the API token.", - "type":"string", - "readOnly":true + "type": "object", + "properties": { + "id": { + "description": "Unique ID of the API token.", + "type": "string", + "readOnly": true }, - "token":{ - "description":"Value of the API token.", - "type":"string", - "readOnly":true + "token": { + "description": "Value of the API token.", + "type": "string", + "readOnly": true }, - "expiry":{ - "description":"String-formatted date representing the time when the token expires.", - "type":"string", - "format":"date-time" + "expiry": { + "description": "String-formatted date representing the time when the token expires.", + "type": "string", + "format": "date-time" } } } ] }, - "ApiTokenCollection":{ - "type":"object", - "properties":{ - "value":{ - "description":"The collection of API tokens.", - "type":"array", - "items":{ - "$ref":"#/definitions/ApiToken" + "ApiTokenCollection": { + "type": "object", + "properties": { + "value": { + "description": "The collection of API tokens.", + "type": "array", + "items": { + "$ref": "#/definitions/ApiToken" } }, - "nextLink":{ - "description":"URL to get the next page of API tokens.", - "type":"string" + "nextLink": { + "description": "URL to get the next page of API tokens.", + "type": "string" } }, - "required":[ + "required": [ "value" ] }, - "Attestation":{ - "type":"object", - "properties":{ - "type":{ - "description":"Type of the attestation.", - "type":"string" + "Attestation": { + "type": "object", + "properties": { + "type": { + "description": "Type of the attestation.", + "type": "string" } }, - "required":[ + "required": [ "type" ], - "discriminator":"type" + "discriminator": "type" }, - "SymmetricKeyAttestation":{ - "allOf":[ + "SymmetricKeyAttestation": { + "allOf": [ { - "$ref":"#/definitions/Attestation" + "$ref": "#/definitions/Attestation" }, { - "type":"object", - "properties":{ - "symmetricKey":{ - "description":"The symmetric key credentials for this attestation.", - "$ref":"#/definitions/SymmetricKey" + "type": "object", + "properties": { + "symmetricKey": { + "description": "The symmetric key credentials for this attestation.", + "$ref": "#/definitions/SymmetricKey" } }, - "required":[ + "required": [ "symmetricKey" ] } ] }, - "X509Attestation":{ - "allOf":[ + "X509Attestation": { + "allOf": [ { - "$ref":"#/definitions/Attestation" + "$ref": "#/definitions/Attestation" }, { - "type":"object", - "properties":{ - "x509":{ - "description":"The X.509 credentials for this attestation.", - "$ref":"#/definitions/X509" + "type": "object", + "properties": { + "x509": { + "description": "The X.509 credentials for this attestation.", + "$ref": "#/definitions/X509" } }, - "required":[ + "required": [ "x509" ] } ] }, - "TpmAttestation":{ - "allOf":[ + "TpmAttestation": { + "allOf": [ { - "$ref":"#/definitions/Attestation" + "$ref": "#/definitions/Attestation" }, { - "type":"object", - "properties":{ - "tpm":{ - "description":"The TPM credentials for this attestation.", - "$ref":"#/definitions/Tpm" + "type": "object", + "properties": { + "tpm": { + "description": "The TPM credentials for this attestation.", + "$ref": "#/definitions/Tpm" } }, - "required":[ + "required": [ "tpm" ] } ] }, - "SchemaField":{ - "allOf":[ + "SchemaField": { + "allOf": [ { - "$ref":"#/definitions/NamedEntity" + "$ref": "#/definitions/NamedEntity" }, { - "type":"object", - "properties":{ - "schema":{ - "description":"The schema of this field." + "type": "object", + "properties": { + "schema": { + "description": "The schema of this field." }, - "displayUnit":{ - "description":"The display name of the unit of this field.", - "type":"string" + "displayUnit": { + "description": "The display name of the unit of this field.", + "type": "string" }, - "unit":{ - "description":"The unit of this field.", - "type":"string" + "unit": { + "description": "The unit of this field.", + "type": "string" } }, - "required":[ + "required": [ "schema" ] } ] }, - "Capability":{ - "allOf":[ + "Capability": { + "allOf": [ { - "$ref":"#/definitions/NamedEntity" + "$ref": "#/definitions/NamedEntity" }, { - "type":"object", - "properties":{ - "schema":{ - "description":"The schema of this field." + "type": "object", + "properties": { + "schema": { + "description": "The schema of this field." }, - "displayUnit":{ - "description":"The display name of the unit of this field.", - "type":"string" + "displayUnit": { + "description": "The display name of the unit of this field.", + "type": "string" }, - "unit":{ - "description":"The unit of this field.", - "type":"string" + "unit": { + "description": "The unit of this field.", + "type": "string" } } }, { - "type":"object", - "properties":{ - "commandType":{ - "description":"The call pattern of this command.", - "type":"string", - "enum":[ + "type": "object", + "properties": { + "commandType": { + "description": "The call pattern of this command.", + "type": "string", + "enum": [ "synchronous", "asynchronous" ] }, - "request":{ - "description":"The request definition for this command.", - "$ref":"#/definitions/SchemaField" + "request": { + "description": "The request definition for this command.", + "$ref": "#/definitions/SchemaField" }, - "response":{ - "description":"The response definition for this command.", - "$ref":"#/definitions/SchemaField" + "response": { + "description": "The response definition for this command.", + "$ref": "#/definitions/SchemaField" } } }, { - "type":"object", - "properties":{ - "writable":{ - "description":"Whether this property is writable.", - "type":"boolean" + "type": "object", + "properties": { + "writable": { + "description": "Whether this property is writable.", + "type": "boolean" } } }, { - "type":"object", - "properties":{ - "target":{ - "description":"The target capability models for this relationship.", - "type":"array", - "items":{ - "type":"string" + "type": "object", + "properties": { + "target": { + "description": "The target capability models for this relationship.", + "type": "array", + "items": { + "type": "string" }, - "minItems":1 + "minItems": 1 }, - "maxMultiplicity":{ - "description":"The maximum multiplicity for this relationship.", - "type":"integer" + "maxMultiplicity": { + "description": "The maximum multiplicity for this relationship.", + "type": "integer" } } } ] }, - "Interface":{ - "allOf":[ + "Interface": { + "allOf": [ { - "$ref":"#/definitions/Entity" + "$ref": "#/definitions/Entity" }, { - "type":"object", - "properties":{ - "contents":{ - "description":"The data definitions contained by the interface.", - "type":"array", - "items":{ - "$ref":"#/definitions/Capability" + "type": "object", + "properties": { + "contents": { + "description": "The data definitions contained by the interface.", + "type": "array", + "items": { + "$ref": "#/definitions/Capability" } } } } ] }, - "Component":{ - "allOf":[ + "Component": { + "allOf": [ { - "$ref":"#/definitions/NamedEntity" + "$ref": "#/definitions/NamedEntity" }, { - "type":"object", - "properties":{ - "schema":{ - "description":"The interface used by this component.", - "$ref":"#/definitions/Interface" + "type": "object", + "properties": { + "schema": { + "description": "The interface used by this component.", + "$ref": "#/definitions/Interface" } } } ] }, - "CapabilityModel":{ - "allOf":[ + "CapabilityModel": { + "allOf": [ { - "$ref":"#/definitions/Entity" + "$ref": "#/definitions/Entity" }, { - "type":"object", - "properties":{ - "implements":{ - "description":"The component implemented by the capability model.", - "type":"array", - "items":{ - "$ref":"#/definitions/Component" + "type": "object", + "properties": { + "implements": { + "description": "The component implemented by the capability model.", + "type": "array", + "items": { + "$ref": "#/definitions/Component" } }, - "contents":{ - "description":"The relationships contained by the capability model.", - "type":"array", - "items":{ - "$ref":"#/definitions/Capability" + "contents": { + "description": "The relationships contained by the capability model.", + "type": "array", + "items": { + "$ref": "#/definitions/Capability" } } } } ] }, - "Endpoint":{ - "type":"object", - "properties":{ - "type":{ - "description":"Type of the endpoint.", - "type":"string" + "Endpoint": { + "type": "object", + "properties": { + "type": { + "description": "Type of the endpoint.", + "type": "string" }, - "connectionString":{ - "description":"Information for connecting to the endpoint.", - "type":"string" + "connectionString": { + "description": "Information for connecting to the endpoint.", + "type": "string" }, - "name":{ - "description":"Name of the entity to send data to.", - "type":"string" + "name": { + "description": "Name of the entity to send data to.", + "type": "string" } }, - "required":[ + "required": [ "type", "connectionString", "name" ], - "discriminator":"type" + "discriminator": "type" }, - "StorageEndpoint":{ - "allOf":[ + "StorageEndpoint": { + "allOf": [ { - "$ref":"#/definitions/Endpoint" + "$ref": "#/definitions/Endpoint" } ] }, - "EventHubsEndpoint":{ - "allOf":[ + "EventHubsEndpoint": { + "allOf": [ { - "$ref":"#/definitions/Endpoint" + "$ref": "#/definitions/Endpoint" } ] }, - "ServiceBusQueueEndpoint":{ - "allOf":[ + "ServiceBusQueueEndpoint": { + "allOf": [ { - "$ref":"#/definitions/Endpoint" + "$ref": "#/definitions/Endpoint" } ] }, - "ServiceBusTopicEndpoint":{ - "allOf":[ + "ServiceBusTopicEndpoint": { + "allOf": [ { - "$ref":"#/definitions/Endpoint" + "$ref": "#/definitions/Endpoint" } ] }, - "ContinuousDataExport":{ - "type":"object", - "properties":{ - "id":{ - "description":"Unique ID of the continuous data export.", - "type":"string", - "readOnly":true - }, - "etag":{ - "description":"ETag used to prevent conflict in continuous data export updates.", - "type":"string" - }, - "displayName":{ - "description":"Display name of the continuous data export.", - "type":"string" - }, - "endpoint":{ - "description":"Location where exported data should be sent.", - "$ref":"#/definitions/Endpoint" - }, - "status":{ - "description":"Indicates whether the continuous data export is starting, running, etc.", - "type":"string", - "readOnly":true - }, - "enabled":{ - "description":"Boolean indicating whether the continuous data export should be running or not.", - "type":"boolean" - }, - "sources":{ - "description":"Data sources to export to the endpoint.", - "type":"array", - "items":{ - "type":"string", - "enum":[ + "ContinuousDataExport": { + "type": "object", + "properties": { + "id": { + "description": "Unique ID of the continuous data export.", + "type": "string", + "readOnly": true + }, + "etag": { + "description": "ETag used to prevent conflict in continuous data export updates.", + "type": "string" + }, + "displayName": { + "description": "Display name of the continuous data export.", + "type": "string" + }, + "endpoint": { + "description": "Location where exported data should be sent.", + "$ref": "#/definitions/Endpoint" + }, + "status": { + "description": "Indicates whether the continuous data export is starting, running, etc.", + "type": "string", + "readOnly": true + }, + "enabled": { + "description": "Boolean indicating whether the continuous data export should be running or not.", + "type": "boolean" + }, + "sources": { + "description": "Data sources to export to the endpoint.", + "type": "array", + "items": { + "type": "string", + "enum": [ "devices", "deviceTemplates", "telemetry" ] }, - "minItems":1 + "minItems": 1 } }, - "required":[ + "required": [ "endpoint", "enabled", "sources" ] }, - "ContinuousDataExportCollection":{ - "type":"object", - "properties":{ - "value":{ - "description":"The collection of continuous data exports.", - "type":"array", - "items":{ - "$ref":"#/definitions/ContinuousDataExport" + "ContinuousDataExportCollection": { + "type": "object", + "properties": { + "value": { + "description": "The collection of continuous data exports.", + "type": "array", + "items": { + "$ref": "#/definitions/ContinuousDataExport" } }, - "nextLink":{ - "description":"URL to get the next page of continuous data exports.", - "type":"string" + "nextLink": { + "description": "URL to get the next page of continuous data exports.", + "type": "string" } }, - "required":[ + "required": [ "value" ] }, - "Device":{ - "type":"object", - "properties":{ - "id":{ - "description":"Unique ID of the device.", - "type":"string", - "readOnly":true + "Device": { + "type": "object", + "properties": { + "id": { + "description": "Unique ID of the device.", + "type": "string", + "readOnly": true }, - "etag":{ - "description":"ETag used to prevent conflict in device updates.", - "type":"string" + "etag": { + "description": "ETag used to prevent conflict in device updates.", + "type": "string" }, - "displayName":{ - "description":"Display name of the device.", - "type":"string" + "displayName": { + "description": "Display name of the device.", + "type": "string" }, - "description":{ - "description":"Detailed description 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" + "instanceOf": { + "description": "The device template definition for the device.", + "type": "string" }, - "simulated":{ - "description":"Whether the device is simulated.", - "type":"boolean" + "simulated": { + "description": "Whether the device is simulated.", + "type": "boolean" }, - "approved":{ - "description":"Whether the device has been approved to connect to IoT Central.", - "type":"boolean" + "approved": { + "description": "Whether the device has been approved to connect to IoT Central.", + "type": "boolean" }, - "provisioned":{ - "description":"Whether resources have been allocated for the device.", - "type":"boolean", - "readOnly":true + "provisioned": { + "description": "Whether resources have been allocated for the device.", + "type": "boolean", + "readOnly": true } }, - "required":[ + "required": [ "instanceOf" ] }, - "DeviceCollection":{ - "type":"object", - "properties":{ - "value":{ - "description":"The collection of devices.", - "type":"array", - "items":{ - "$ref":"#/definitions/Device" + "DeviceCollection": { + "type": "object", + "properties": { + "value": { + "description": "The collection of devices.", + "type": "array", + "items": { + "$ref": "#/definitions/Device" } }, - "nextLink":{ - "description":"URL to get the next page of devices.", - "type":"string" + "nextLink": { + "description": "URL to get the next page of devices.", + "type": "string" } }, - "required":[ + "required": [ "value" ] }, - "DeviceCloudProperties":{ - "description":"Cloud property values associated with the device.", - "type":"object", - "additionalProperties":true + "DeviceCloudProperties": { + "description": "Cloud property values associated with the device.", + "type": "object", + "additionalProperties": true }, - "DeviceCommand":{ - "type":"object", - "properties":{ - "id":{ - "description":"The request ID of the device command execution.", - "type":"string", - "readOnly":true + "DeviceCommand": { + "type": "object", + "properties": { + "id": { + "description": "The request ID of the device command execution.", + "type": "string", + "readOnly": true }, - "request":{ - "description":"The payload for the device command." + "request": { + "description": "The payload for the device command." }, - "response":{ - "description":"The payload of the device command response.", - "readOnly":true + "response": { + "description": "The payload of the device command response.", + "readOnly": true }, - "responseCode":{ - "description":"The status code of the device command response.", - "type":"integer", - "readOnly":true + "responseCode": { + "description": "The status code of the device command response.", + "type": "integer", + "readOnly": true } } }, - "DeviceCommandCollection":{ - "type":"object", - "properties":{ - "value":{ - "description":"The collection of device command executions.", - "type":"array", - "items":{ - "$ref":"#/definitions/DeviceCommand" + "DeviceCommandCollection": { + "type": "object", + "properties": { + "value": { + "description": "The collection of device command executions.", + "type": "array", + "items": { + "$ref": "#/definitions/DeviceCommand" } }, - "nextLink":{ - "description":"URL to get the next page of device command executions.", - "type":"string" + "nextLink": { + "description": "URL to get the next page of device command executions.", + "type": "string" } }, - "required":[ + "required": [ "value" ] }, - "DeviceCredentials":{ - "type":"object", - "properties":{ - "idScope":{ - "description":"ID scope for connecting to the IoT Central application.", - "type":"string" + "DeviceCredentials": { + "type": "object", + "properties": { + "idScope": { + "description": "ID scope for connecting to the IoT Central application.", + "type": "string" }, - "symmetricKey":{ - "description":"The symmetric key credentials for the device.", - "$ref":"#/definitions/SymmetricKey" + "symmetricKey": { + "description": "The symmetric key credentials for the device.", + "$ref": "#/definitions/SymmetricKey" }, - "x509":{ - "description":"The X.509 credential information for the device.", - "$ref":"#/definitions/X509" + "x509": { + "description": "The X.509 credential information for the device.", + "$ref": "#/definitions/X509" }, - "tpm":{ - "description":"The TPM credentials for the device.", - "$ref":"#/definitions/Tpm" + "tpm": { + "description": "The TPM credentials for the device.", + "$ref": "#/definitions/Tpm" } }, - "required":[ + "required": [ "idScope" ] }, - "DeviceProperties":{ - "description":"Property values associated with the device.", - "type":"object", - "additionalProperties":true + "DeviceProperties": { + "description": "Property values associated with the device.", + "type": "object", + "additionalProperties": true }, - "DeviceTelemetry":{ - "type":"object", - "properties":{ - "value":{ - "description":"The last known value of this device telemetry." + "DeviceTelemetry": { + "type": "object", + "properties": { + "value": { + "description": "The last known value of this device telemetry." }, - "timestamp":{ - "description":"String-formatted date representing the time when the telemetry value was sent.", - "type":"string", - "format":"date-time" + "timestamp": { + "description": "String-formatted date representing the time when the telemetry value was sent.", + "type": "string", + "format": "date-time" } } }, - "DeviceTemplate":{ - "type":"object", - "properties":{ - "id":{ - "description":"Unique ID of the device template.", - "type":"string", - "readOnly":true + "DeviceTemplate": { + "type": "object", + "properties": { + "id": { + "description": "Unique ID of the device template.", + "type": "string", + "readOnly": true }, - "etag":{ - "description":"ETag used to prevent conflict in device template updates.", - "type":"string" + "etag": { + "description": "ETag used to prevent conflict in device template updates.", + "type": "string" }, - "types":{ - "description":"The types of device to which this template applies.", - "type":"array", - "items":{ - "type":"string" + "types": { + "description": "The types of device to which this template applies.", + "type": "array", + "items": { + "type": "string" } }, - "displayName":{ - "description":"Display name of the device template.", - "type":"string" + "displayName": { + "description": "Display name of the device template.", + "type": "string" }, - "description":{ - "description":"Detailed description of the device template.", - "type":"string" + "description": { + "description": "Detailed description of the device template.", + "type": "string" }, - "capabilityModel":{ - "description":"The capability model utilized by this device template.", - "$ref":"#/definitions/CapabilityModel" + "capabilityModel": { + "description": "The capability model utilized by this device template.", + "$ref": "#/definitions/CapabilityModel" }, - "solutionModel":{ - "description":"The solution model utilized by this device template.", - "$ref":"#/definitions/SolutionModel" + "solutionModel": { + "description": "The solution model utilized by this device template.", + "$ref": "#/definitions/SolutionModel" } }, - "required":[ + "required": [ "types", "capabilityModel" ] }, - "DeviceTemplateCollection":{ - "type":"object", - "properties":{ - "value":{ - "description":"The collection of device templates.", - "type":"array", - "items":{ - "$ref":"#/definitions/DeviceTemplate" + "DeviceTemplateCollection": { + "type": "object", + "properties": { + "value": { + "description": "The collection of device templates.", + "type": "array", + "items": { + "$ref": "#/definitions/DeviceTemplate" } }, - "nextLink":{ - "description":"URL to get the next page of device templates.", - "type":"string" + "nextLink": { + "description": "URL to get the next page of device templates.", + "type": "string" } }, - "required":[ + "required": [ "value" ] }, - "SymmetricKey":{ - "type":"object", - "properties":{ - "primaryKey":{ - "description":"The primary key for this credential.", - "type":"string" + "SymmetricKey": { + "type": "object", + "properties": { + "primaryKey": { + "description": "The primary key for this credential.", + "type": "string" }, - "secondaryKey":{ - "description":"The secondary key for this credential.", - "type":"string" + "secondaryKey": { + "description": "The secondary key for this credential.", + "type": "string" } }, - "required":[ + "required": [ "primaryKey", "secondaryKey" ] }, - "Tpm":{ - "type":"object", - "properties":{ - "endorsementKey":{ - "description":"The TPM endorsement key for this credential.", - "type":"string" + "Tpm": { + "type": "object", + "properties": { + "endorsementKey": { + "description": "The TPM endorsement key for this credential.", + "type": "string" } }, - "required":[ + "required": [ "endorsementKey" ] }, - "X509":{ - "type":"object", - "properties":{ - "clientCertificates":{ - "description":"The X.509 client certificates for this credential.", - "$ref":"#/definitions/X509Certificates" + "X509": { + "type": "object", + "properties": { + "clientCertificates": { + "description": "The X.509 client certificates for this credential.", + "$ref": "#/definitions/X509Certificates" } }, - "required":[ + "required": [ "clientCertificates" ] }, - "X509Certificates":{ - "type":"object", - "properties":{ - "primary":{ - "description":"The primary X.509 certificate for this credential.", - "$ref":"#/definitions/X509Certificate" + "X509Certificates": { + "type": "object", + "properties": { + "primary": { + "description": "The primary X.509 certificate for this credential.", + "$ref": "#/definitions/X509Certificate" }, - "secondary":{ - "description":"The secondary X.509 certificate for this credential.", - "$ref":"#/definitions/X509Certificate" + "secondary": { + "description": "The secondary X.509 certificate for this credential.", + "$ref": "#/definitions/X509Certificate" } }, - "required":[ + "required": [ "primary" ] }, - "X509Certificate":{ - "type":"object", - "properties":{ - "certificate":{ - "description":"The string representation of this certificate.", - "type":"string" + "X509Certificate": { + "type": "object", + "properties": { + "certificate": { + "description": "The string representation of this certificate.", + "type": "string" }, - "info":{ - "description":"Information about this certificate.", - "readOnly":true, - "$ref":"#/definitions/X509CertificateInfo" + "info": { + "description": "Information about this certificate.", + "readOnly": true, + "$ref": "#/definitions/X509CertificateInfo" } } }, - "X509CertificateInfo":{ - "type":"object", - "properties":{ - "sha1Thumbprint":{ - "description":"The SHA-1 hash value of the certificate.", - "type":"string" + "X509CertificateInfo": { + "type": "object", + "properties": { + "sha1Thumbprint": { + "description": "The SHA-1 hash value of the certificate.", + "type": "string" } }, - "required":[ + "required": [ "sha1Thumbprint" ] }, - "Entity":{ - "type":"object", - "properties":{ - "@context":{ - "description":"JSON-LD context for the entity." - }, - "@id":{ - "description":"Unique ID of the entity.", - "type":"string" - }, - "@type":{ - "description":"Type of the entity.", - "type":"array", - "items":{ - "type":"string" + "Entity": { + "type": "object", + "properties": { + "@context": { + "description": "JSON-LD context for the entity." + }, + "@id": { + "description": "Unique ID of the entity.", + "type": "string" + }, + "@type": { + "description": "Type of the entity.", + "type": "array", + "items": { + "type": "string" }, - "minItems":1 + "minItems": 1 }, - "displayName":{ - "description":"Display name of the entity.", - "type":"string" + "displayName": { + "description": "Display name of the entity.", + "type": "string" }, - "description":{ - "description":"Detailed description of the entity.", - "type":"string" + "description": { + "description": "Detailed description of the entity.", + "type": "string" }, - "comment":{ - "description":"Developer comment about the entity.", - "type":"string" + "comment": { + "description": "Developer comment about the entity.", + "type": "string" } }, - "required":[ + "required": [ "@type" ] }, - "NamedEntity":{ - "allOf":[ + "NamedEntity": { + "allOf": [ { - "$ref":"#/definitions/Entity" + "$ref": "#/definitions/Entity" }, { - "type":"object", - "properties":{ - "name":{ - "description":"The programmatic name of the named entity.", - "type":"string" + "type": "object", + "properties": { + "name": { + "description": "The programmatic name of the named entity.", + "type": "string" } }, - "required":[ + "required": [ "name" ] } ] }, - "Permission":{ - "type":"object", - "properties":{ - "roles":{ - "description":"Roles that the permission has been granted permission to.", - "type":"array", - "items":{ - "type":"string" + "Permission": { + "type": "object", + "properties": { + "roles": { + "description": "Roles that the permission has been granted permission to.", + "type": "array", + "items": { + "type": "string" }, - "minItems":1, - "maxItems":1 + "minItems": 1, + "maxItems": 1 } }, - "required":[ + "required": [ "roles" ] }, - "Role":{ - "type":"object", - "properties":{ - "id":{ - "description":"Unique ID of the role.", - "type":"string", - "readOnly":true + "Role": { + "type": "object", + "properties": { + "id": { + "description": "Unique ID of the role.", + "type": "string", + "readOnly": true }, - "displayName":{ - "description":"Display name of the role.", - "type":"string" + "displayName": { + "description": "Display name of the role.", + "type": "string" } } }, - "RoleCollection":{ - "type":"object", - "properties":{ - "value":{ - "description":"The collection of roles.", - "type":"array", - "items":{ - "$ref":"#/definitions/Role" + "RoleCollection": { + "type": "object", + "properties": { + "value": { + "description": "The collection of roles.", + "type": "array", + "items": { + "$ref": "#/definitions/Role" } }, - "nextLink":{ - "description":"URL to get the next page of roles.", - "type":"string" + "nextLink": { + "description": "URL to get the next page of roles.", + "type": "string" } }, - "required":[ + "required": [ "value" ] }, - "SolutionModel":{ - "allOf":[ + "SolutionModel": { + "allOf": [ { - "$ref":"#/definitions/Entity" + "$ref": "#/definitions/Entity" }, { - "type":"object", - "properties":{ - "cloudProperties":{ - "description":"The cloud properties defined by the solution model.", - "type":"array", - "items":{ - "$ref":"#/definitions/Capability" + "type": "object", + "properties": { + "cloudProperties": { + "description": "The cloud properties defined by the solution model.", + "type": "array", + "items": { + "$ref": "#/definitions/Capability" } }, - "initialValues":{ - "description":"The initial values defined by the solution model.", - "type":"array", - "items":{ - "$ref":"#/definitions/InitialValue" + "initialValues": { + "description": "The initial values defined by the solution model.", + "type": "array", + "items": { + "$ref": "#/definitions/InitialValue" } }, - "overrides":{ - "description":"The overrides defined by the solution model.", - "type":"array", - "items":{ - "$ref":"#/definitions/Override" + "overrides": { + "description": "The overrides defined by the solution model.", + "type": "array", + "items": { + "$ref": "#/definitions/Override" } } } } ] }, - "InitialValue":{ - "allOf":[ + "InitialValue": { + "allOf": [ { - "$ref":"#/definitions/Entity" + "$ref": "#/definitions/Entity" }, { - "type":"object", - "properties":{ - "capability":{ - "description":"The reference to the capability for which an initial value is being provided.", - "$ref":"#/definitions/CapabilityReference" + "type": "object", + "properties": { + "capability": { + "description": "The reference to the capability for which an initial value is being provided.", + "$ref": "#/definitions/CapabilityReference" }, - "value":{ - "description":"The initial value of the capability." + "value": { + "description": "The initial value of the capability." } } } ] }, - "Override":{ - "allOf":[ + "Override": { + "allOf": [ { - "$ref":"#/definitions/Entity" + "$ref": "#/definitions/Entity" }, { - "type":"object", - "properties":{ - "capability":{ - "description":"The reference to the capability which is being overridden.", - "$ref":"#/definitions/CapabilityReference" + "type": "object", + "properties": { + "capability": { + "description": "The reference to the capability which is being overridden.", + "$ref": "#/definitions/CapabilityReference" }, - "displayUnit":{ - "description":"The overridden display unit for the referenced capability.", - "type":"string" + "displayUnit": { + "description": "The overridden display unit for the referenced capability.", + "type": "string" }, - "semanticType":{ - "description":"The overridden semantic type for the referenced capability.", - "type":"string" + "semanticType": { + "description": "The overridden semantic type for the referenced capability.", + "type": "string" }, - "unit":{ - "description":"The overridden unit for the referenced capability.", - "type":"string" + "unit": { + "description": "The overridden unit for the referenced capability.", + "type": "string" }, - "valueDetail":{ - "description":"Visualization details for the referenced capability.", - "$ref":"#/definitions/ValueDetail" + "valueDetail": { + "description": "Visualization details for the referenced capability.", + "$ref": "#/definitions/ValueDetail" } } } ] }, - "ValueDetail":{ - "allOf":[ + "ValueDetail": { + "allOf": [ { - "$ref":"#/definitions/Entity" + "$ref": "#/definitions/Entity" }, { - "type":"object", - "properties":{ - "falseName":{ - "description":"The string representation of a false value.", - "type":"string" + "type": "object", + "properties": { + "falseName": { + "description": "The string representation of a false value.", + "type": "string" }, - "trueName":{ - "description":"The string representation of a true value.", - "type":"string" + "trueName": { + "description": "The string representation of a true value.", + "type": "string" } } }, { - "type":"object", - "properties":{ - "hideTime":{ - "description":"Specifies that the time portion of the date-time value should be hidden.", - "type":"boolean" + "type": "object", + "properties": { + "hideTime": { + "description": "Specifies that the time portion of the date-time value should be hidden.", + "type": "boolean" } } }, { - "type":"object", - "properties":{ - "severity":{ - "description":"Specifies the severity of the event.", - "type":"string", - "enum":[ + "type": "object", + "properties": { + "severity": { + "description": "Specifies the severity of the event.", + "type": "string", + "enum": [ "error", "warning", "information" @@ -930,983 +930,983 @@ } }, { - "type":"object", - "properties":{ - "decimalPlaces":{ - "description":"The number of decimal places that should be displayed for the number.", - "type":"integer" + "type": "object", + "properties": { + "decimalPlaces": { + "description": "The number of decimal places that should be displayed for the number.", + "type": "integer" }, - "maxValue":{ - "description":"The maximum expected value of the number.", - "type":"number" + "maxValue": { + "description": "The maximum expected value of the number.", + "type": "number" }, - "minValue":{ - "description":"The minimum expected value of the number.", - "type":"number" + "minValue": { + "description": "The minimum expected value of the number.", + "type": "number" } } }, { - "type":"object", - "properties":{ - "maxLength":{ - "description":"The maximum expected length of the string.", - "type":"integer" + "type": "object", + "properties": { + "maxLength": { + "description": "The maximum expected length of the string.", + "type": "integer" }, - "minLength":{ - "description":"The minimum expected length of the string.", - "type":"integer" + "minLength": { + "description": "The minimum expected length of the string.", + "type": "integer" }, - "trimWhitespace":{ - "description":"Specifies the visual and storage treatment of white spaces in the string.", - "type":"boolean" + "trimWhitespace": { + "description": "Specifies the visual and storage treatment of white spaces in the string.", + "type": "boolean" } } } ] }, - "CapabilityReference":{ - "allOf":[ + "CapabilityReference": { + "allOf": [ { - "$ref":"#/definitions/Entity" + "$ref": "#/definitions/Entity" }, { - "type":"object", - "properties":{ - "component":{ - "description":"The name of the component being referenced.", - "type":"string" + "type": "object", + "properties": { + "component": { + "description": "The name of the component being referenced.", + "type": "string" }, - "reference":{ - "description":"The name of the capability being referenced.", - "type":"string" + "reference": { + "description": "The name of the capability being referenced.", + "type": "string" } } } ] } }, - "paths":{ - "/apiTokens":{ - "get":{ - "operationId":"ApiTokens_List", - "summary":"Get the list of API tokens in an application.", - "x-ms-examples":{ - "List API tokens":{ - "$ref":"./examples/apitoken_list.json" - } - }, - "responses":{ - "200":{ - "description":"Success", - "schema":{ - "$ref":"#/definitions/ApiTokenCollection" + "paths": { + "/apiTokens": { + "get": { + "operationId": "ApiTokens_List", + "summary": "Get the list of API tokens in an application.", + "x-ms-examples": { + "List API tokens": { + "$ref": "./examples/apitoken_list.json" + } + }, + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/ApiTokenCollection" } } } } }, - "/apiTokens/{token_id}":{ - "parameters":[ + "/apiTokens/{token_id}": { + "parameters": [ { - "in":"path", - "name":"token_id", - "description":"Unique ID for the API token.", - "type":"string", - "required":true + "in": "path", + "name": "token_id", + "description": "Unique ID for the API token.", + "type": "string", + "required": true } ], - "get":{ - "operationId":"ApiTokens_Get", - "summary":"Get an API token by ID.", - "x-ms-examples":{ - "Get API token by ID":{ - "$ref":"./examples/apitoken_get.json" - } - }, - "responses":{ - "200":{ - "description":"Success", - "schema":{ - "$ref":"#/definitions/ApiToken" + "get": { + "operationId": "ApiTokens_Get", + "summary": "Get an API token by ID.", + "x-ms-examples": { + "Get API token by ID": { + "$ref": "./examples/apitoken_get.json" + } + }, + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/ApiToken" } } } }, - "put":{ - "operationId":"ApiTokens_Set", - "summary":"Create a new API token in the application.", - "x-ms-examples":{ - "Create API token":{ - "$ref":"./examples/apitoken_create.json" + "put": { + "operationId": "ApiTokens_Set", + "summary": "Create a new API token in the application.", + "x-ms-examples": { + "Create API token": { + "$ref": "./examples/apitoken_create.json" } }, - "parameters":[ + "parameters": [ { - "in":"path", - "name":"token_id", - "description":"Unique ID for the API token.", - "type":"string", - "required":true + "in": "path", + "name": "token_id", + "description": "Unique ID for the API token.", + "type": "string", + "required": true }, { - "name":"body", - "in":"body", - "description":"API token body.", - "required":true, - "schema":{ - "$ref":"#/definitions/ApiToken" + "name": "body", + "in": "body", + "description": "API token body.", + "required": true, + "schema": { + "$ref": "#/definitions/ApiToken" } } ], - "responses":{ - "200":{ - "description":"Success", - "schema":{ - "$ref":"#/definitions/ApiToken" + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/ApiToken" } } } }, - "delete":{ - "operationId":"ApiTokens_Remove", - "summary":"Delete an API token.", - "parameters":[ + "delete": { + "operationId": "ApiTokens_Remove", + "summary": "Delete an API token.", + "parameters": [ { - "in":"path", - "name":"token_id", - "description":"Unique ID for the API token.", - "type":"string", - "required":true + "in": "path", + "name": "token_id", + "description": "Unique ID for the API token.", + "type": "string", + "required": true } ], - "x-ms-examples":{ - "Delete API token":{ - "$ref":"./examples/apitoken_delete.json" + "x-ms-examples": { + "Delete API token": { + "$ref": "./examples/apitoken_delete.json" } }, - "responses":{ - "204":{ - "description":"Success" + "responses": { + "204": { + "description": "Success" } } } }, - "/continuousDataExports":{ - "get":{ - "operationId":"ContinuousDataExports_List", - "summary":"Get the list of continuous data exports in an application.", - "x-ms-examples":{ - "List exports":{ - "$ref":"./examples/continuousdataexports_list.json" + "/continuousDataExports": { + "get": { + "operationId": "ContinuousDataExports_List", + "summary": "Get the list of continuous data exports in an application.", + "x-ms-examples": { + "List exports": { + "$ref": "./examples/continuousdataexports_list.json" } }, - "responses":{ - "200":{ - "description":"Success", - "schema":{ - "$ref":"#/definitions/ContinuousDataExportCollection" + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/ContinuousDataExportCollection" } } } } }, - "/continuousDataExports/{export_id}":{ - "parameters":[ + "/continuousDataExports/{export_id}": { + "parameters": [ { - "in":"path", - "name":"export_id", - "description":"Unique ID for the continuous data export.", - "type":"string", - "required":true + "in": "path", + "name": "export_id", + "description": "Unique ID for the continuous data export.", + "type": "string", + "required": true } ], - "get":{ - "operationId":"ContinuousDataExports_Get", - "summary":"Get a continuous data export by ID.", - "x-ms-examples":{ - "Get export":{ - "$ref":"./examples/continuousdataexports_get.json" - } - }, - "responses":{ - "200":{ - "description":"Success", - "schema":{ - "$ref":"#/definitions/ContinuousDataExport" + "get": { + "operationId": "ContinuousDataExports_Get", + "summary": "Get a continuous data export by ID.", + "x-ms-examples": { + "Get export": { + "$ref": "./examples/continuousdataexports_get.json" + } + }, + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/ContinuousDataExport" } } } }, - "put":{ - "operationId":"ContinuousDataExports_Set", - "summary":"Create a new continuous data export or update an existing one by ID.", - "x-ms-examples":{ - "Create or update export":{ - "$ref":"./examples/continuousdataexports_set.json" + "put": { + "operationId": "ContinuousDataExports_Set", + "summary": "Create a new continuous data export or update an existing one by ID.", + "x-ms-examples": { + "Create or update export": { + "$ref": "./examples/continuousdataexports_set.json" } }, - "parameters":[ + "parameters": [ { - "in":"path", - "name":"export_id", - "description":"Unique ID for the continuous data export.", - "type":"string", - "required":true + "in": "path", + "name": "export_id", + "description": "Unique ID for the continuous data export.", + "type": "string", + "required": true }, { - "name":"body", - "in":"body", - "description":"Data export body.", - "required":true, - "schema":{ - "$ref":"#/definitions/ContinuousDataExport" + "name": "body", + "in": "body", + "description": "Data export body.", + "required": true, + "schema": { + "$ref": "#/definitions/ContinuousDataExport" } } ], - "responses":{ - "200":{ - "description":"Success", - "schema":{ - "$ref":"#/definitions/ContinuousDataExport" + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/ContinuousDataExport" } } } }, - "delete":{ - "operationId":"ContinuousDataExports_Remove", - "summary":"Delete a continuous data export.", - "parameters":[ + "delete": { + "operationId": "ContinuousDataExports_Remove", + "summary": "Delete a continuous data export.", + "parameters": [ { - "in":"path", - "name":"export_id", - "description":"Unique ID for the continuous data export.", - "type":"string", - "required":true + "in": "path", + "name": "export_id", + "description": "Unique ID for the continuous data export.", + "type": "string", + "required": true } ], - "x-ms-examples":{ - "Delete export":{ - "$ref":"./examples/continuousdataexports_delete.json" + "x-ms-examples": { + "Delete export": { + "$ref": "./examples/continuousdataexports_delete.json" } }, - "responses":{ - "204":{ - "description":"Success" + "responses": { + "204": { + "description": "Success" } } } }, - "/deviceTemplates":{ - "get":{ - "operationId":"DeviceTemplates_List", - "summary":"Get the list of device templates in an application", - "x-ms-examples":{ - "List device templates":{ - "$ref":"./examples/devicetemplates_list.json" + "/deviceTemplates": { + "get": { + "operationId": "DeviceTemplates_List", + "summary": "Get the list of device templates in an application", + "x-ms-examples": { + "List device templates": { + "$ref": "./examples/devicetemplates_list.json" } }, - "responses":{ - "200":{ - "description":"Success", - "schema":{ - "$ref":"#/definitions/DeviceTemplateCollection" + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/DeviceTemplateCollection" } } } } }, - "/deviceTemplates/{device_template_id}":{ - "get":{ - "operationId":"DeviceTemplates_Get", - "summary":"Get a device template by ID", - "parameters":[ - { - "$ref":"#/parameters/DeviceTemplateId" - } - ], - "x-ms-examples":{ - "Get a device template by Id":{ - "$ref":"./examples/devicetemplates_get.json" - } - }, - "responses":{ - "200":{ - "description":"Success", - "schema":{ - "$ref":"#/definitions/DeviceTemplate" + "/deviceTemplates/{device_template_id}": { + "get": { + "operationId": "DeviceTemplates_Get", + "summary": "Get a device template by ID", + "parameters": [ + { + "$ref": "#/parameters/DeviceTemplateId" + } + ], + "x-ms-examples": { + "Get a device template by Id": { + "$ref": "./examples/devicetemplates_get.json" + } + }, + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/DeviceTemplate" } } } }, - "delete":{ - "operationId":"DeviceTemplates_Remove", - "summary":"Delete a device template", - "description":"Delete an existing device template by device ID.", - "parameters":[ + "delete": { + "operationId": "DeviceTemplates_Remove", + "summary": "Delete a device template", + "description": "Delete an existing device template by device ID.", + "parameters": [ { - "$ref":"#/parameters/DeviceTemplateId" + "$ref": "#/parameters/DeviceTemplateId" } ], - "x-ms-examples":{ - "Delete a device template by Id":{ - "$ref":"./examples/devicetemplates_delete.json" + "x-ms-examples": { + "Delete a device template by Id": { + "$ref": "./examples/devicetemplates_delete.json" } }, - "responses":{ - "204":{ - "description":"Success" + "responses": { + "204": { + "description": "Success" } } }, - "put":{ - "operationId":"DeviceTemplates_Set", - "summary":"Create or update a device template", - "x-ms-examples":{ - "Create a device template":{ - "$ref":"./examples/devicetemplates_create.json" + "put": { + "operationId": "DeviceTemplates_Set", + "summary": "Create or update a device template", + "x-ms-examples": { + "Create a device template": { + "$ref": "./examples/devicetemplates_create.json" } }, - "parameters":[ + "parameters": [ { - "$ref":"#/parameters/DeviceTemplateId" + "$ref": "#/parameters/DeviceTemplateId" }, { - "name":"body", - "in":"body", - "description":"Device template body.", - "required":true, - "schema":{ - "$ref":"#/definitions/DeviceTemplate" + "name": "body", + "in": "body", + "description": "Device template body.", + "required": true, + "schema": { + "$ref": "#/definitions/DeviceTemplate" } } ], - "responses":{ - "200":{ - "description":"Success", - "schema":{ - "$ref":"#/definitions/DeviceTemplate" + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/DeviceTemplate" } } } } }, - "/deviceTemplates/{device_template_id}/merged":{ - "get":{ - "operationId":"DeviceTemplates_GetMerged", - "summary":"Get a merged device template by ID", - "parameters":[ - { - "$ref":"#/parameters/DeviceTemplateId" - } - ], - "x-ms-examples":{ - "Get a merged device template by Id":{ - "$ref":"./examples/devicetemplates_get_merged.json" - } - }, - "responses":{ - "200":{ - "description":"Success", - "schema":{ - "$ref":"#/definitions/DeviceTemplate" + "/deviceTemplates/{device_template_id}/merged": { + "get": { + "operationId": "DeviceTemplates_GetMerged", + "summary": "Get a merged device template by ID", + "parameters": [ + { + "$ref": "#/parameters/DeviceTemplateId" + } + ], + "x-ms-examples": { + "Get a merged device template by Id": { + "$ref": "./examples/devicetemplates_get_merged.json" + } + }, + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/DeviceTemplate" } } } } }, - "/deviceTemplates/{device_template_id}/devices":{ - "get":{ - "operationId":"DeviceTemplates_ListDevices", - "summary":"Get devices for a template", - "parameters":[ - { - "$ref":"#/parameters/DeviceTemplateId" - } - ], - "x-ms-examples":{ - "List devices associated to a device template":{ - "$ref":"./examples/devices_list_by_template.json" - } - }, - "responses":{ - "200":{ - "description":"Success", - "schema":{ - "$ref":"#/definitions/DeviceCollection" + "/deviceTemplates/{device_template_id}/devices": { + "get": { + "operationId": "DeviceTemplates_ListDevices", + "summary": "Get devices for a template", + "parameters": [ + { + "$ref": "#/parameters/DeviceTemplateId" + } + ], + "x-ms-examples": { + "List devices associated to a device template": { + "$ref": "./examples/devices_list_by_template.json" + } + }, + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/DeviceCollection" } } } } }, - "/devices":{ - "get":{ - "operationId":"Devices_List", - "summary":"Get the list of devices in an application", - "x-ms-examples":{ - "List devices":{ - "$ref":"./examples/devices_list.json" + "/devices": { + "get": { + "operationId": "Devices_List", + "summary": "Get the list of devices in an application", + "x-ms-examples": { + "List devices": { + "$ref": "./examples/devices_list.json" } }, - "responses":{ - "200":{ - "description":"Success", - "schema":{ - "$ref":"#/definitions/DeviceCollection" + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/DeviceCollection" } } } } }, - "/devices/{device_id}":{ - "get":{ - "operationId":"Devices_Get", - "summary":"Get a device by ID", - "description":"Get details about an existing device by device ID.", - "parameters":[ - { - "$ref":"#/parameters/DeviceId" - } - ], - "x-ms-examples":{ - "Get device by Id":{ - "$ref":"./examples/devices_get.json" - } - }, - "responses":{ - "200":{ - "description":"Success", - "schema":{ - "$ref":"#/definitions/Device" + "/devices/{device_id}": { + "get": { + "operationId": "Devices_Get", + "summary": "Get a device by ID", + "description": "Get details about an existing device by device ID.", + "parameters": [ + { + "$ref": "#/parameters/DeviceId" + } + ], + "x-ms-examples": { + "Get device by Id": { + "$ref": "./examples/devices_get.json" + } + }, + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/Device" } } } }, - "put":{ - "operationId":"Devices_Set", - "summary":"Create or update a device", - "description":"Create a new device or update an existing one by device ID.", - "x-ms-examples":{ - "Create device":{ - "$ref":"./examples/devices_create.json" + "put": { + "operationId": "Devices_Set", + "summary": "Create or update a device", + "description": "Create a new device or update an existing one by device ID.", + "x-ms-examples": { + "Create device": { + "$ref": "./examples/devices_create.json" } }, - "parameters":[ + "parameters": [ { - "$ref":"#/parameters/DeviceId" + "$ref": "#/parameters/DeviceId" }, { - "name":"body", - "in":"body", - "description":"Device body.", - "required":true, - "schema":{ - "$ref":"#/definitions/Device" + "name": "body", + "in": "body", + "description": "Device body.", + "required": true, + "schema": { + "$ref": "#/definitions/Device" } } ], - "responses":{ - "200":{ - "description":"Success", - "schema":{ - "$ref":"#/definitions/Device" + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/Device" } } } }, - "delete":{ - "operationId":"Devices_Remove", - "summary":"Delete a device", - "description":"Delete an existing device by device ID.", - "parameters":[ + "delete": { + "operationId": "Devices_Remove", + "summary": "Delete a device", + "description": "Delete an existing device by device ID.", + "parameters": [ { - "$ref":"#/parameters/DeviceId" + "$ref": "#/parameters/DeviceId" } ], - "x-ms-examples":{ - "Delete device":{ - "$ref":"./examples/devices_delete.json" + "x-ms-examples": { + "Delete device": { + "$ref": "./examples/devices_delete.json" } }, - "responses":{ - "204":{ - "description":"Success" + "responses": { + "204": { + "description": "Success" } } } }, - "/roles":{ - "get":{ - "operationId":"Roles_List", - "summary":"Get the list of roles in an application.", - "x-ms-examples":{ - "List roles":{ - "$ref":"./examples/roles_list.json" + "/roles": { + "get": { + "operationId": "Roles_List", + "summary": "Get the list of roles in an application.", + "x-ms-examples": { + "List roles": { + "$ref": "./examples/roles_list.json" } }, - "responses":{ - "200":{ - "description":"Success", - "schema":{ - "$ref":"#/definitions/RoleCollection" + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/RoleCollection" } } } } }, - "/roles/{role_id}":{ - "get":{ - "operationId":"Roles_Get", - "summary":"Get a role by ID.", - "parameters":[ - { - "in":"path", - "name":"role_id", - "description":"Unique ID for the role.", - "type":"string", - "required":true - } - ], - "x-ms-examples":{ - "Get role by Id":{ - "$ref":"./examples/roles_get.json" - } - }, - "responses":{ - "200":{ - "description":"Success", - "schema":{ - "$ref":"#/definitions/Role" + "/roles/{role_id}": { + "get": { + "operationId": "Roles_Get", + "summary": "Get a role by ID.", + "parameters": [ + { + "in": "path", + "name": "role_id", + "description": "Unique ID for the role.", + "type": "string", + "required": true + } + ], + "x-ms-examples": { + "Get role by Id": { + "$ref": "./examples/roles_get.json" + } + }, + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/Role" } } } } }, - "/devices/{device_id}/attestation":{ - "parameters":[ + "/devices/{device_id}/attestation": { + "parameters": [ { - "$ref":"#/parameters/DeviceId" + "$ref": "#/parameters/DeviceId" } ], - "get":{ - "operationId":"Devices_GetAttestation", - "summary":"Get device attestation", - "x-ms-examples":{ - "Get device attestation":{ - "$ref":"./examples/devices_attestations_get.json" - } - }, - "responses":{ - "200":{ - "description":"Success", - "schema":{ - "$ref":"#/definitions/Attestation" + "get": { + "operationId": "Devices_GetAttestation", + "summary": "Get device attestation", + "x-ms-examples": { + "Get device attestation": { + "$ref": "./examples/devices_attestations_get.json" + } + }, + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/Attestation" } } } }, - "put":{ - "operationId":"Devices_SetAttestation", - "summary":"Create or update an individual device attestation", - "parameters":[ + "put": { + "operationId": "Devices_SetAttestation", + "summary": "Create or update an individual device attestation", + "parameters": [ { - "$ref":"#/parameters/DeviceId" + "$ref": "#/parameters/DeviceId" }, { - "name":"body", - "in":"body", - "description":"Individual device attestation body.", - "required":true, - "schema":{ - "$ref":"#/definitions/Attestation" + "name": "body", + "in": "body", + "description": "Individual device attestation body.", + "required": true, + "schema": { + "$ref": "#/definitions/Attestation" } } ], - "x-ms-examples":{ - "Create or update device attestation":{ - "$ref":"./examples/devices_attestations_set.json" + "x-ms-examples": { + "Create or update device attestation": { + "$ref": "./examples/devices_attestations_set.json" } }, - "responses":{ - "200":{ - "description":"Success", - "schema":{ - "$ref":"#/definitions/Attestation" + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/Attestation" } } } }, - "delete":{ - "operationId":"Devices_RemoveAttestation", - "summary":"Remove an individual device attestation", - "parameters":[ + "delete": { + "operationId": "Devices_RemoveAttestation", + "summary": "Remove an individual device attestation", + "parameters": [ { - "$ref":"#/parameters/DeviceId" + "$ref": "#/parameters/DeviceId" } ], - "x-ms-examples":{ - "Delete device attestation":{ - "$ref":"./examples/devices_attestations_delete.json" + "x-ms-examples": { + "Delete device attestation": { + "$ref": "./examples/devices_attestations_delete.json" } }, - "responses":{ - "204":{ - "description":"Success" + "responses": { + "204": { + "description": "Success" } } } }, - "/devices/{device_id}/cloudProperties":{ - "parameters":[ + "/devices/{device_id}/cloudProperties": { + "parameters": [ { - "$ref":"#/parameters/DeviceId" + "$ref": "#/parameters/DeviceId" } ], - "get":{ - "operationId":"Devices_GetCloudProperties", - "summary":"Get device cloud properties", - "description":"Get all cloud property values of a device by device ID.", - "x-ms-examples":{ - "Get cloud properties":{ - "$ref":"./examples/devices_cloudproperties_get.json" - } - }, - "responses":{ - "200":{ - "description":"Success", - "schema":{ - "$ref":"#/definitions/DeviceCloudProperties" + "get": { + "operationId": "Devices_GetCloudProperties", + "summary": "Get device cloud properties", + "description": "Get all cloud property values of a device by device ID.", + "x-ms-examples": { + "Get cloud properties": { + "$ref": "./examples/devices_cloudproperties_get.json" + } + }, + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/DeviceCloudProperties" } } } }, - "put":{ - "operationId":"Devices_UpdateCloudProperties", - "summary":"Update device cloud properties", - "description":"Update all cloud property values of a device by device ID.", - "x-ms-examples":{ - "Update cloud properties":{ - "$ref":"./examples/devices_cloudproperties_update.json" + "put": { + "operationId": "Devices_UpdateCloudProperties", + "summary": "Update device cloud properties", + "description": "Update all cloud property values of a device by device ID.", + "x-ms-examples": { + "Update cloud properties": { + "$ref": "./examples/devices_cloudproperties_update.json" } }, - "parameters":[ + "parameters": [ { - "name":"body", - "in":"body", - "description":"Device properties.", - "required":true, - "schema":{ - "$ref":"#/definitions/DeviceCloudProperties" + "name": "body", + "in": "body", + "description": "Device properties.", + "required": true, + "schema": { + "$ref": "#/definitions/DeviceCloudProperties" } } ], - "responses":{ - "200":{ - "description":"Success", - "schema":{ - "$ref":"#/definitions/DeviceCloudProperties" + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/DeviceCloudProperties" } } } } }, - "/devices/{device_id}/components/{component_name}/commands/{command_name}":{ - "parameters":[ + "/devices/{device_id}/components/{component_name}/commands/{command_name}": { + "parameters": [ { - "$ref":"#/parameters/DeviceId" + "$ref": "#/parameters/DeviceId" }, { - "$ref":"#/parameters/ComponentName" + "$ref": "#/parameters/ComponentName" }, { - "in":"path", - "name":"command_name", - "description":"Name of this device command.", + "in": "path", + "name": "command_name", + "description": "Name of this device command.", "x-ms-parameter-location": "method", - "type":"string", - "required":true + "type": "string", + "required": true } ], - "get":{ - "operationId":"Devices_GetCommandHistory", - "summary":"Get device command history", - "x-ms-examples":{ - "Get command history":{ - "$ref":"./examples/devices_commandshistory_get.json" - } - }, - "responses":{ - "200":{ - "description":"Success", - "schema":{ - "$ref":"#/definitions/DeviceCommandCollection" + "get": { + "operationId": "Devices_GetCommandHistory", + "summary": "Get device command history", + "x-ms-examples": { + "Get command history": { + "$ref": "./examples/devices_commandshistory_get.json" + } + }, + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/DeviceCommandCollection" } } } }, - "post":{ - "operationId":"Devices_ExecuteCommand", - "summary":"Execute a device command", - "description":"Execute a command on a device.", - "x-ms-examples":{ - "Send command":{ - "$ref":"./examples/devices_commands_send.json" + "post": { + "operationId": "Devices_ExecuteCommand", + "summary": "Execute a device command", + "description": "Execute a command on a device.", + "x-ms-examples": { + "Send command": { + "$ref": "./examples/devices_commands_send.json" } }, - "parameters":[ + "parameters": [ { - "name":"body", - "in":"body", - "description":"Device command body.", - "required":true, - "schema":{ - "$ref":"#/definitions/DeviceCommand" + "name": "body", + "in": "body", + "description": "Device command body.", + "required": true, + "schema": { + "$ref": "#/definitions/DeviceCommand" } } ], - "responses":{ - "201":{ - "description":"Success", - "schema":{ - "$ref":"#/definitions/DeviceCommand" + "responses": { + "201": { + "description": "Success", + "schema": { + "$ref": "#/definitions/DeviceCommand" } } } } }, - "/devices/{device_id}/credentials":{ - "parameters":[ + "/devices/{device_id}/credentials": { + "parameters": [ { - "$ref":"#/parameters/DeviceId" + "$ref": "#/parameters/DeviceId" } ], - "get":{ - "operationId":"Devices_GetCredentials", - "summary":"Get device credentials", - "x-ms-examples":{ - "Get device credentials":{ - "$ref":"./examples/devicecredentials_get.json" - } - }, - "responses":{ - "200":{ - "description":"Success", - "schema":{ - "$ref":"#/definitions/DeviceCredentials" + "get": { + "operationId": "Devices_GetCredentials", + "summary": "Get device credentials", + "x-ms-examples": { + "Get device credentials": { + "$ref": "./examples/devicecredentials_get.json" + } + }, + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/DeviceCredentials" } } } } }, - "/devices/{device_id}/properties":{ - "parameters":[ + "/devices/{device_id}/properties": { + "parameters": [ { - "$ref":"#/parameters/DeviceId" + "$ref": "#/parameters/DeviceId" } ], - "get":{ - "operationId":"Devices_GetProperties", - "summary":"Get device properties", - "description":"Get all property values of a device by device ID.", - "x-ms-examples":{ - "Update properties":{ - "$ref":"./examples/devices_properties_get.json" - } - }, - "responses":{ - "200":{ - "description":"Success", - "schema":{ - "$ref":"#/definitions/DeviceProperties" + "get": { + "operationId": "Devices_GetProperties", + "summary": "Get device properties", + "description": "Get all property values of a device by device ID.", + "x-ms-examples": { + "Update properties": { + "$ref": "./examples/devices_properties_get.json" + } + }, + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/DeviceProperties" } } } }, - "put":{ - "operationId":"Devices_UpdateProperties", - "summary":"Update device properties", - "description":"Update all property values of a device by device ID.", - "x-ms-examples":{ - "Update properties":{ - "$ref":"./examples/devices_properties_update.json" + "put": { + "operationId": "Devices_UpdateProperties", + "summary": "Update device properties", + "description": "Update all property values of a device by device ID.", + "x-ms-examples": { + "Update properties": { + "$ref": "./examples/devices_properties_update.json" } }, - "parameters":[ + "parameters": [ { - "name":"body", - "in":"body", - "description":"Device properties.", - "required":true, - "schema":{ - "$ref":"#/definitions/DeviceProperties" + "name": "body", + "in": "body", + "description": "Device properties.", + "required": true, + "schema": { + "$ref": "#/definitions/DeviceProperties" } } ], - "responses":{ - "202":{ - "description":"Success", - "schema":{ - "$ref":"#/definitions/DeviceProperties" + "responses": { + "202": { + "description": "Success", + "schema": { + "$ref": "#/definitions/DeviceProperties" } } } } }, - "/devices/{device_id}/components/{component_name}/properties":{ - "parameters":[ + "/devices/{device_id}/components/{component_name}/properties": { + "parameters": [ { - "$ref":"#/parameters/DeviceId" + "$ref": "#/parameters/DeviceId" }, { - "$ref":"#/parameters/ComponentName" + "$ref": "#/parameters/ComponentName" } ], - "get":{ - "operationId":"Devices_GetComponentProperties", - "summary":"Get device properties for a specific component", - "x-ms-examples":{ - "Get properties on components":{ - "$ref":"./examples/devices_properties_components_get.json" - } - }, - "responses":{ - "200":{ - "description":"Success", - "schema":{ - "$ref":"#/definitions/DeviceProperties" + "get": { + "operationId": "Devices_GetComponentProperties", + "summary": "Get device properties for a specific component", + "x-ms-examples": { + "Get properties on components": { + "$ref": "./examples/devices_properties_components_get.json" + } + }, + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/DeviceProperties" } } } }, - "put":{ - "operationId":"Devices_UpdateComponentProperties", - "summary":"Update device properties for a specific component", - "x-ms-examples":{ - "Update properties on components":{ - "$ref":"./examples/devices_properties_components_set.json" + "put": { + "operationId": "Devices_UpdateComponentProperties", + "summary": "Update device properties for a specific component", + "x-ms-examples": { + "Update properties on components": { + "$ref": "./examples/devices_properties_components_set.json" } }, - "parameters":[ + "parameters": [ { - "name":"body", - "in":"body", - "description":"Device properties.", - "required":true, - "schema":{ - "$ref":"#/definitions/DeviceProperties" + "name": "body", + "in": "body", + "description": "Device properties.", + "required": true, + "schema": { + "$ref": "#/definitions/DeviceProperties" } } ], - "responses":{ - "202":{ - "description":"Success", - "schema":{ - "$ref":"#/definitions/DeviceProperties" + "responses": { + "202": { + "description": "Success", + "schema": { + "$ref": "#/definitions/DeviceProperties" } } } } }, - "/devices/{device_id}/components/{component_name}/telemetry/{telemetry_name}":{ - "parameters":[ + "/devices/{device_id}/components/{component_name}/telemetry/{telemetry_name}": { + "parameters": [ { - "$ref":"#/parameters/DeviceId" + "$ref": "#/parameters/DeviceId" }, { - "$ref":"#/parameters/ComponentName" + "$ref": "#/parameters/ComponentName" }, { - "in":"path", - "name":"telemetry_name", - "description":"Name of this device telemetry.", + "in": "path", + "name": "telemetry_name", + "description": "Name of this device telemetry.", "x-ms-parameter-location": "method", - "type":"string", - "required":true + "type": "string", + "required": true } ], - "get":{ - "operationId":"Devices_GetTelemetryValue", - "summary":"Get device telemetry value", - "x-ms-examples":{ - "Get telemetry":{ - "$ref":"./examples/devices_telemetry_get.json" - } - }, - "responses":{ - "200":{ - "description":"Success", - "schema":{ - "$ref":"#/definitions/DeviceTelemetry" + "get": { + "operationId": "Devices_GetTelemetryValue", + "summary": "Get device telemetry value", + "x-ms-examples": { + "Get telemetry": { + "$ref": "./examples/devices_telemetry_get.json" + } + }, + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/DeviceTelemetry" } } } } + } + }, + "parameters": { + "DeviceTemplateId": { + "in": "path", + "name": "device_template_id", + "description": "Unique ID of the device template.", + "x-ms-parameter-location": "method", + "type": "string", + "required": true + }, + "DeviceId": { + "in": "path", + "name": "device_id", + "description": "Unique ID of the device.", + "x-ms-parameter-location": "method", + "type": "string", + "required": true + }, + "ComponentName": { + "in": "path", + "name": "component_name", + "description": "Name of the device component.", + "x-ms-parameter-location": "method", + "type": "string", + "required": true + }, + "Subdomain": { + "in": "path", + "name": "subdomain", + "description": "Application subdomain.", + "x-ms-parameter-location": "client", + "type": "string", + "required": true + }, + "CentralDnsSuffixInPath": { + "name": "centralDnsSuffixInPath", + "in": "path", + "required": true, + "type": "string", + "default": "azureiotcentral.com", + "x-ms-skip-url-encoding": true, + "description": "The DNS suffix used as the base for all Azure IoT Central service requests.", + "x-ms-parameter-location": "client" + } + }, + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow", + "scopes": { + "user_impersonation": "impersonate your user account" } - }, - "parameters":{ - "DeviceTemplateId":{ - "in":"path", - "name":"device_template_id", - "description":"Unique ID of the device template.", - "x-ms-parameter-location": "method", - "type":"string", - "required":true - }, - "DeviceId":{ - "in":"path", - "name":"device_id", - "description":"Unique ID of the device.", - "x-ms-parameter-location": "method", - "type":"string", - "required":true - }, - "ComponentName":{ - "in":"path", - "name":"component_name", - "description":"Name of the device component.", - "x-ms-parameter-location": "method", - "type":"string", - "required":true - }, - "Subdomain":{ - "in":"path", - "name":"subdomain", - "description":"Application subdomain.", - "x-ms-parameter-location":"client", - "type":"string", - "required":true + } + }, + "x-ms-parameterized-host": { + "hostTemplate": "{subdomain}.{centralDnsSuffixInPath}", + "parameters": [ + { + "$ref": "#/parameters/Subdomain" }, - "CentralDnsSuffixInPath":{ - "name":"centralDnsSuffixInPath", - "in":"path", - "required":true, - "type":"string", - "default":"azureiotcentral.com", - "x-ms-skip-url-encoding":true, - "description":"The DNS suffix used as the base for all Azure IoT Central service requests.", - "x-ms-parameter-location":"client" - } - }, - "securityDefinitions":{ - "azure_auth":{ - "type":"oauth2", - "authorizationUrl":"https://login.microsoftonline.com/common/oauth2/authorize", - "flow":"implicit", - "description":"Azure Active Directory OAuth2 Flow", - "scopes":{ - "user_impersonation":"impersonate your user account" - } + { + "$ref": "#/parameters/CentralDnsSuffixInPath" } - }, - "x-ms-parameterized-host":{ - "hostTemplate":"{subdomain}.{centralDnsSuffixInPath}", - "parameters":[ - { - "$ref":"#/parameters/Subdomain" - }, - { - "$ref":"#/parameters/CentralDnsSuffixInPath" - } - ] - } - } \ No newline at end of file + ] + } +} From b797792d438e9db4b5805d7af3ba2c5d29f17d94 Mon Sep 17 00:00:00 2001 From: Vivian Liu Date: Mon, 2 Mar 2020 10:36:33 -0800 Subject: [PATCH 6/8] Made suggested changes --- .../2019-10-28-preview/iotcentral.json | 30 +++++++++++++++++-- 1 file changed, 28 insertions(+), 2 deletions(-) diff --git a/specification/iotcentral/data-plane/Microsoft.IoTCentral/preview/2019-10-28-preview/iotcentral.json b/specification/iotcentral/data-plane/Microsoft.IoTCentral/preview/2019-10-28-preview/iotcentral.json index 4d991e7e22eb..dcaddaa2781b 100644 --- a/specification/iotcentral/data-plane/Microsoft.IoTCentral/preview/2019-10-28-preview/iotcentral.json +++ b/specification/iotcentral/data-plane/Microsoft.IoTCentral/preview/2019-10-28-preview/iotcentral.json @@ -184,6 +184,9 @@ "properties": { "commandType": { "description": "The call pattern of this command.", + "x-ms-enum": { + "modelAsString": true + }, "type": "string", "enum": [ "synchronous", @@ -920,6 +923,9 @@ "properties": { "severity": { "description": "Specifies the severity of the event.", + "x-ms-enum": { + "modelAsString": true + }, "type": "string", "enum": [ "error", @@ -996,6 +1002,9 @@ "$ref": "./examples/apitoken_list.json" } }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, "responses": { "200": { "description": "Success", @@ -1101,6 +1110,9 @@ "$ref": "./examples/continuousdataexports_list.json" } }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, "responses": { "200": { "description": "Success", @@ -1109,7 +1121,6 @@ } } } - } }, "/continuousDataExports/{export_id}": { "parameters": [ @@ -1206,6 +1217,9 @@ "$ref": "./examples/devicetemplates_list.json" } }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, "responses": { "200": { "description": "Success", @@ -1329,6 +1343,9 @@ "$ref": "./examples/devices_list_by_template.json" } }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, "responses": { "200": { "description": "Success", @@ -1348,6 +1365,9 @@ "$ref": "./examples/devices_list.json" } }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, "responses": { "200": { "description": "Success", @@ -1444,6 +1464,9 @@ "$ref": "./examples/roles_list.json" } }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, "responses": { "200": { "description": "Success", @@ -1635,6 +1658,9 @@ "$ref": "./examples/devices_commandshistory_get.json" } }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, "responses": { "200": { "description": "Success", @@ -1709,7 +1735,7 @@ "summary": "Get device properties", "description": "Get all property values of a device by device ID.", "x-ms-examples": { - "Update properties": { + "Get properties": { "$ref": "./examples/devices_properties_get.json" } }, From 637116c7f3e93b74f98c9cfc9e1378ba5f8ecb2b Mon Sep 17 00:00:00 2001 From: Vivian Liu Date: Mon, 2 Mar 2020 10:47:47 -0800 Subject: [PATCH 7/8] Missing bracket --- .../preview/2019-10-28-preview/iotcentral.json | 1 + 1 file changed, 1 insertion(+) diff --git a/specification/iotcentral/data-plane/Microsoft.IoTCentral/preview/2019-10-28-preview/iotcentral.json b/specification/iotcentral/data-plane/Microsoft.IoTCentral/preview/2019-10-28-preview/iotcentral.json index dcaddaa2781b..d841505719c8 100644 --- a/specification/iotcentral/data-plane/Microsoft.IoTCentral/preview/2019-10-28-preview/iotcentral.json +++ b/specification/iotcentral/data-plane/Microsoft.IoTCentral/preview/2019-10-28-preview/iotcentral.json @@ -1121,6 +1121,7 @@ } } } + } }, "/continuousDataExports/{export_id}": { "parameters": [ From c8a5380fa8c8519f3166382d8e47d4d3c46e13f2 Mon Sep 17 00:00:00 2001 From: Vivian Liu Date: Mon, 2 Mar 2020 10:55:50 -0800 Subject: [PATCH 8/8] Adding names to x-ms-enums --- .../preview/2019-10-28-preview/iotcentral.json | 2 ++ 1 file changed, 2 insertions(+) diff --git a/specification/iotcentral/data-plane/Microsoft.IoTCentral/preview/2019-10-28-preview/iotcentral.json b/specification/iotcentral/data-plane/Microsoft.IoTCentral/preview/2019-10-28-preview/iotcentral.json index d841505719c8..bd048373ad98 100644 --- a/specification/iotcentral/data-plane/Microsoft.IoTCentral/preview/2019-10-28-preview/iotcentral.json +++ b/specification/iotcentral/data-plane/Microsoft.IoTCentral/preview/2019-10-28-preview/iotcentral.json @@ -185,6 +185,7 @@ "commandType": { "description": "The call pattern of this command.", "x-ms-enum": { + "name": "CommandTypes", "modelAsString": true }, "type": "string", @@ -924,6 +925,7 @@ "severity": { "description": "Specifies the severity of the event.", "x-ms-enum": { + "name": "EventSeverity", "modelAsString": true }, "type": "string",