Skip to content

Add suggested type name changes to iothub swagger #12296

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 5 commits into from
May 27, 2020
Merged

Add suggested type name changes to iothub swagger #12296

Changes from 4 commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
d4587f7
Add suggested type name changes to iothub swagger
timtay-microsoft May 26, 2020
c93c73c
address cr comment
timtay-microsoft May 26, 2020
276450a
DeviceStatistics, not RegistryStatistics
timtay-microsoft May 26, 2020
2940758
ImportExportJobProperties
timtay-microsoft May 26, 2020
75ad051
More TwinConfiguration renames
timtay-microsoft May 26, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
92 changes: 46 additions & 46 deletions sdk/iot/Azure.Iot.Hub.Service/src/swagger/iothubservice_modified.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@
"200": {
"description": "Returns the Configuration.",
"schema": {
"$ref": "#/definitions/Configuration"
"$ref": "#/definitions/TwinConfiguration"
}
}
}
Expand Down Expand Up @@ -62,7 +62,7 @@
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/Configuration"
"$ref": "#/definitions/TwinConfiguration"
},
"description": "The configuration to be created or updated."
},
Expand All @@ -81,13 +81,13 @@
"200": {
"description": "Returns the updated configuration",
"schema": {
"$ref": "#/definitions/Configuration"
"$ref": "#/definitions/TwinConfiguration"
}
},
"201": {
"description": "Returns the created configuration",
"schema": {
"$ref": "#/definitions/Configuration"
"$ref": "#/definitions/TwinConfiguration"
}
}
}
Expand Down Expand Up @@ -154,7 +154,7 @@
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/Configuration"
"$ref": "#/definitions/TwinConfiguration"
}
}
}
Expand Down Expand Up @@ -214,7 +214,7 @@
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/RegistryStatistics"
"$ref": "#/definitions/DeviceStatistics"
}
}
}
Expand Down Expand Up @@ -272,7 +272,7 @@
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/Device"
"$ref": "#/definitions/DeviceIdentity"
}
}
}
Expand All @@ -296,7 +296,7 @@
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/ExportImportDevice"
"$ref": "#/definitions/RegistryOperationRequest"
},
"description": "The set of registry operations to perform."
}
Expand Down Expand Up @@ -366,7 +366,7 @@
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/Twin"
"$ref": "#/definitions/TwinData"
}
},
"headers": {
Expand Down Expand Up @@ -408,7 +408,7 @@
"200": {
"description": "Returns the Device.",
"schema": {
"$ref": "#/definitions/Device"
"$ref": "#/definitions/DeviceIdentity"
}
}
}
Expand Down Expand Up @@ -436,7 +436,7 @@
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/Device"
"$ref": "#/definitions/DeviceIdentity"
},
"description": "The contents of the device to create."
},
Expand All @@ -455,7 +455,7 @@
"200": {
"description": "Returns the Device",
"schema": {
"$ref": "#/definitions/Device"
"$ref": "#/definitions/DeviceIdentity"
}
}
}
Expand Down Expand Up @@ -557,7 +557,7 @@
"description": "Specifies the job specification.",
"required": true,
"schema": {
"$ref": "#/definitions/JobProperties"
"$ref": "#/definitions/ImportExportJobProperties"
}
},
{
Expand All @@ -568,7 +568,7 @@
"200": {
"description": "Returns the JobProperties",
"schema": {
"$ref": "#/definitions/JobProperties"
"$ref": "#/definitions/ImportExportJobProperties"
}
}
}
Expand All @@ -594,7 +594,7 @@
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/JobProperties"
"$ref": "#/definitions/ImportExportJobProperties"
}
}
}
Expand Down Expand Up @@ -626,7 +626,7 @@
"200": {
"description": "Returns the JobProperties",
"schema": {
"$ref": "#/definitions/JobProperties"
"$ref": "#/definitions/ImportExportJobProperties"
}
}
}
Expand Down Expand Up @@ -773,7 +773,7 @@
"200": {
"description": "OK.",
"schema": {
"$ref": "#/definitions/Twin"
"$ref": "#/definitions/TwinData"
}
}
}
Expand Down Expand Up @@ -802,7 +802,7 @@
"description": "The twin object that will replace the current device twin.",
"required": true,
"schema": {
"$ref": "#/definitions/Twin"
"$ref": "#/definitions/TwinData"
}
},
{
Expand All @@ -820,7 +820,7 @@
"200": {
"description": "The updated device twin.",
"schema": {
"$ref": "#/definitions/Twin"
"$ref": "#/definitions/TwinData"
}
}
}
Expand Down Expand Up @@ -849,7 +849,7 @@
"description": "The twin object containing the tags and desired properties to be updated.",
"required": true,
"schema": {
"$ref": "#/definitions/Twin"
"$ref": "#/definitions/TwinData"
}
},
{
Expand All @@ -867,7 +867,7 @@
"200": {
"description": "The updated device twin.",
"schema": {
"$ref": "#/definitions/Twin"
"$ref": "#/definitions/TwinData"
}
}
}
Expand Down Expand Up @@ -905,7 +905,7 @@
"200": {
"description": "The module state information.",
"schema": {
"$ref": "#/definitions/Twin"
"$ref": "#/definitions/TwinData"
}
}
}
Expand Down Expand Up @@ -941,7 +941,7 @@
"description": "The twin object that will replace the current module twin.",
"required": true,
"schema": {
"$ref": "#/definitions/Twin"
"$ref": "#/definitions/TwinData"
}
},
{
Expand All @@ -959,7 +959,7 @@
"200": {
"description": "The updated module twin.",
"schema": {
"$ref": "#/definitions/Twin"
"$ref": "#/definitions/TwinData"
}
}
}
Expand Down Expand Up @@ -995,7 +995,7 @@
"description": "The twin object containing the tags and desired properties to be updated.",
"required": true,
"schema": {
"$ref": "#/definitions/Twin"
"$ref": "#/definitions/TwinData"
}
},
{
Expand All @@ -1013,7 +1013,7 @@
"200": {
"description": "The updated module twin.",
"schema": {
"$ref": "#/definitions/Twin"
"$ref": "#/definitions/TwinData"
}
}
}
Expand Down Expand Up @@ -1400,7 +1400,7 @@
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/Module"
"$ref": "#/definitions/ModuleIdentity"
}
}
}
Expand Down Expand Up @@ -1439,7 +1439,7 @@
"200": {
"description": "Returns the module.",
"schema": {
"$ref": "#/definitions/Module"
"$ref": "#/definitions/ModuleIdentity"
}
}
}
Expand Down Expand Up @@ -1474,7 +1474,7 @@
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/Module"
"$ref": "#/definitions/ModuleIdentity"
},
"description": "The module identity."
},
Expand All @@ -1493,13 +1493,13 @@
"200": {
"description": "Returns the updated module.",
"schema": {
"$ref": "#/definitions/Module"
"$ref": "#/definitions/ModuleIdentity"
}
},
"201": {
"description": "Returns the created module.",
"schema": {
"$ref": "#/definitions/Module"
"$ref": "#/definitions/ModuleIdentity"
}
}
}
Expand Down Expand Up @@ -1646,7 +1646,7 @@
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/CloudToDeviceMethod"
"$ref": "#/definitions/CloudToDeviceMethodRequest"
},
"description": "Parameters to execute a direct method on the device."
},
Expand Down Expand Up @@ -1695,7 +1695,7 @@
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/CloudToDeviceMethod"
"$ref": "#/definitions/CloudToDeviceMethodRequest"
},
"description": "Parameters to execute a direct method on the module."
},
Expand Down Expand Up @@ -1817,8 +1817,8 @@
}
}
},
"Configuration": {
"description": "Configuration for IotHub devices and modules.",
"TwinConfiguration": {
"description": "Configuration for IotHub device and module twins.",
"type": "object",
"properties": {
"id": {
Expand Down Expand Up @@ -1937,7 +1937,7 @@
}
}
},
"RegistryStatistics": {
"DeviceStatistics": {
"type": "object",
"properties": {
"totalDeviceCount": {
Expand Down Expand Up @@ -1971,7 +1971,7 @@
}
}
},
"Device": {
"DeviceIdentity": {
"type": "object",
"properties": {
"deviceId": {
Expand Down Expand Up @@ -2115,7 +2115,7 @@
}
}
},
"ExportImportDevice": {
"RegistryOperationRequest": {
"type": "object",
"properties": {
"id": {
Expand Down Expand Up @@ -2524,7 +2524,7 @@
}
}
},
"Twin": {
"TwinData": {
"description": "The state information for a device or module. Implicitly created and deleted when the corresponding device/ module identity is created or deleted in IoT Hub.",
"type": "object",
"properties": {
Expand Down Expand Up @@ -2659,7 +2659,7 @@
}
}
},
"JobProperties": {
"ImportExportJobProperties": {
"type": "object",
"properties": {
"jobId": {
Expand Down Expand Up @@ -2929,11 +2929,11 @@
"type": "string"
},
"cloudToDeviceMethod": {
"$ref": "#/definitions/CloudToDeviceMethod",
"$ref": "#/definitions/CloudToDeviceMethodRequest",
Copy link
Contributor

@bikamani bikamani May 26, 2020

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Where is the definition for CloudToDeviceMethodRequest?

Copy link
Member Author

@timtay-microsoft timtay-microsoft May 26, 2020

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks like I missed changing it. I'll push the fix for that

"description": "Required if jobType is cloudToDeviceMethod. The method type and parameters."
},
"updateTwin": {
"$ref": "#/definitions/Twin"
"$ref": "#/definitions/TwinData"
},
"queryCondition": {
"description": "Required if jobType is updateTwin or cloudToDeviceMethod. Condition for device query to get devices to execute the job on.",
Expand All @@ -2954,7 +2954,7 @@
"type"
]
},
"CloudToDeviceMethod": {
"CloudToDeviceMethodRequest": {
"description": "Parameters to execute a direct method on the device.",
"type": "object",
"properties": {
Expand Down Expand Up @@ -3039,12 +3039,12 @@
"type": "string"
},
"cloudToDeviceMethod": {
"$ref": "#/definitions/CloudToDeviceMethod",
"$ref": "#/definitions/CloudToDeviceMethodRequest",
"description": "Required if jobType is cloudToDeviceMethod. The method type and parameters.",
"readOnly": true
},
"updateTwin": {
"$ref": "#/definitions/Twin",
"$ref": "#/definitions/TwinData",
"readOnly": true
},
"status": {
Expand Down Expand Up @@ -3144,7 +3144,7 @@
}
}
},
"Module": {
"ModuleIdentity": {
"description": "Module identity on a device.",
"type": "object",
"properties": {
Expand Down