Skip to content
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

Jump to bottom

Swagger changes for Client grouping #12245

Merged
merged 7 commits into from
May 26, 2020
Merged

Swagger changes for Client grouping #12245

Changes from 4 commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
cf3682c
operation id changes
bikamani May 21, 2020
94b6e27
addressing comments
bikamani May 21, 2020
ad6ace4
remove IoTHub word from query
bikamani May 21, 2020
77f7c49
append identity and few more changes
bikamani May 26, 2020
03122cb
identities
bikamani May 26, 2020
6c3d025
add jobs changes
bikamani May 26, 2020
a2fdc7c
gettwins
bikamani 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
64 changes: 32 additions & 32 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 @@ -200,7 +200,7 @@
"get": {
"summary": "Retrieves statistics about device identities in the IoT hub's identity registry.",
"description": "Get statistics about device identities in the IoT hub's identity registry, such as total device count.",
"operationId": "RegistryManager_GetDeviceStatistics",
"operationId": "Statistics_GetDeviceStatistics",
"consumes": [],
"produces": [
"application/json"
Expand All @@ -224,7 +224,7 @@
"get": {
"summary": "Retrieves service statistics for this IoT hub's identity registry.",
"description": "Retrieves device statistics for this IoT hub, such as connected device count.",
"operationId": "RegistryManager_GetServiceStatistics",
"operationId": "Statistics_GetServiceStatistics",
"consumes": [],
"produces": [
"application/json"
Expand All @@ -248,7 +248,7 @@
"get": {
"summary": "Get the identities of multiple devices from the IoT hub identity registry. Not recommended. Use the IoT Hub query language to retrieve device twin and device identity information. See https://docs.microsoft.com/en-us/rest/api/iothub/service/queryiothub and https://docs.microsoft.com/en-us/azure/iot-hub/iot-hub-devguide-query-language for more information.",
"description": "Get the identities of multiple devices from the IoT hub identity registry. Not recommended. Use the IoT Hub query API to retrieve device twin and device identity information. See https://docs.microsoft.com/en-us/rest/api/iothub/service/queryiothub and https://docs.microsoft.com/en-us/azure/iot-hub/iot-hub-devguide-query-language for more information.",
"operationId": "RegistryManager_GetDevices",
"operationId": "Devices_Get",
bikamani marked this conversation as resolved.
Show resolved Hide resolved
"consumes": [],
"produces": [
"application/json"
Expand Down Expand Up @@ -281,7 +281,7 @@
"post": {
"summary": "Create, update, or delete the identities of multiple devices from the IoT hub identity registry.",
"description": "Create, update, or delete the identiies of multiple devices from the IoT hub identity registry. A device identity can be specified only once in the list. Different operations (create, update, delete) on different devices are allowed. A maximum of 100 devices can be specified per invocation. For large scale operations, consider using the import feature using blob storage(https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-identity-registry#import-and-export-device-identities).",
"operationId": "RegistryManager_BulkDeviceCRUD",
"operationId": "Devices_BulkRegistryOperations",
Copy link
Contributor Author

Choose a reason for hiding this comment

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

We haven't come to conclusion for this set grouping. Leaving it as it for now.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

One suggestion is call this Registry_BulkOperations

"consumes": [
"application/json"
],
Expand Down Expand Up @@ -325,7 +325,7 @@
"post": {
"summary": "Query an IoT hub to retrieve information regarding device twins using a SQL-like language.",
"description": "Query an IoT hub to retrieve information regarding device twins using a SQL-like language. See https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-query-language for more information. Pagination is supported. This returns information about device twins only.",
"operationId": "RegistryManager_QueryIotHub",
"operationId": "Devices_Query",
bikamani marked this conversation as resolved.
Show resolved Hide resolved
"consumes": [
"application/json"
],
Expand Down Expand Up @@ -387,7 +387,7 @@
"get": {
"summary": "Retrieve a device from the identity registry of an IoT hub.",
"description": "Get a device from the identity registry of an IoT hub.",
"operationId": "RegistryManager_GetDevice",
"operationId": "Devices_GetIdentity",
"consumes": [],
"produces": [
"application/json"
Expand Down Expand Up @@ -416,7 +416,7 @@
"put": {
"summary": "Create or update the identity of a device in the identity registry of an IoT hub.",
"description": "Create or update the identity of a device in the identity registry of an IoT hub.",
"operationId": "RegistryManager_CreateOrUpdateDevice",
"operationId": "Devices_CreateOrUpdateIdentity",
"consumes": [
"application/json"
],
Expand Down Expand Up @@ -463,7 +463,7 @@
"delete": {
"summary": "Delete the identity of a device from the identity registry of an IoT hub.",
"description": "Delete the identity of a device from the identity registry of an IoT hub.",
"operationId": "RegistryManager_DeleteDevice",
"operationId": "Devices_DeleteIdentity",
"consumes": [],
"produces": [
"application/json"
Expand Down Expand Up @@ -543,7 +543,7 @@
"post": {
"summary": "Create a new import/export job on an IoT hub.",
"description": "Create a new import or export job on IoT Hub. See https://docs.microsoft.com/en-us/azure/iot-hub/iot-hub-devguide-identity-registry#import-and-export-device-identities for more information.",
"operationId": "JobClient_CreateImportExportJob",
"operationId": "Jobs_CreateImportExportJob",
bikamani marked this conversation as resolved.
Show resolved Hide resolved
"consumes": [
"application/json"
],
Expand Down Expand Up @@ -578,7 +578,7 @@
"get": {
"summary": "Gets the status of all import/export jobs in an iot hub",
"description": "Get the status of all import and export jobs in IoT Hub. See https://docs.microsoft.com/en-us/azure/iot-hub/iot-hub-devguide-identity-registry#import-and-export-device-identities for more information.",
"operationId": "JobClient_GetImportExportJobs",
"operationId": "Jobs_GetImportExportJobs",
"consumes": [],
"produces": [
"application/json"
Expand All @@ -605,7 +605,7 @@
"get": {
"summary": "Gets the status of an import or export job in an iot hub",
"description": "Get the status of an import or export job in IoT Hub. See https://docs.microsoft.com/en-us/azure/iot-hub/iot-hub-devguide-identity-registry#import-and-export-device-identities for more information.",
"operationId": "JobClient_GetImportExportJob",
"operationId": "Jobs_GetImportExportJob",
"consumes": [],
"produces": [
"application/json"
Expand Down Expand Up @@ -634,7 +634,7 @@
"delete": {
"summary": "Cancels an import or export job in an IoT hub.",
"description": "Cancels an import or export job in IoT Hub.",
"operationId": "JobClient_CancelImportExportJob",
"operationId": "Jobs_CancelImportExportJob",
"consumes": [],
"produces": [
"application/json"
Expand Down Expand Up @@ -668,7 +668,7 @@
"delete": {
"summary": "Deletes all the pending commands for this device from the IoT hub.",
"description": "Deletes all the pending commands for this device from the IoT hub.",
"operationId": "RegistryManager_PurgeCommandQueue",
"operationId": "Messages_PurgeCloudToDeviceMessageQueue",
"consumes": [],
"produces": [
"application/json"
Expand Down Expand Up @@ -752,7 +752,7 @@
"get": {
"summary": "Gets a device twin.",
"description": "Gets the device twin. See https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-device-twins for more information.",
"operationId": "Twin_GetDeviceTwin",
"operationId": "Devices_GetTwin",
"consumes": [],
"produces": [
"application/json"
Expand Down Expand Up @@ -781,7 +781,7 @@
"put": {
"summary": "Replaces tags and desired properties of a device twin.",
"description": "Replaces the tags and desired properties of a device. See https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-device-twins for more information.",
"operationId": "Twin_ReplaceDeviceTwin",
"operationId": "Devices_ReplaceTwin",
"consumes": [
"application/json"
],
Expand Down Expand Up @@ -828,7 +828,7 @@
"patch": {
"summary": "Updates tags and desired properties of a device twin.",
"description": "Updates the tags and desired properties of a device. See https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-device-twins for more information.",
"operationId": "Twin_UpdateDeviceTwin",
"operationId": "Devices_UpdateTwin",
"consumes": [
"application/json"
],
Expand Down Expand Up @@ -877,7 +877,7 @@
"get": {
"summary": "Gets a module twin.",
"description": "Gets the module twin. See https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-device-twins for more information.",
"operationId": "Twin_GetModuleTwin",
"operationId": "Modules_GetTwin",
bikamani marked this conversation as resolved.
Show resolved Hide resolved
"consumes": [],
"produces": [
"application/json"
Expand Down Expand Up @@ -913,7 +913,7 @@
"put": {
"summary": "Replaces tags and desired properties of a module twin.",
"description": "Replaces the tags and desired properties of a module. See https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-device-twins for more information.",
"operationId": "Twin_ReplaceModuleTwin",
"operationId": "Modules_ReplaceTwin",
"consumes": [
"application/json"
],
Expand Down Expand Up @@ -967,7 +967,7 @@
"patch": {
"summary": "Updates tags and desired properties of a module twin.",
"description": "Updates the tags and desired properties of a module. See https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-device-twins for more information.",
"operationId": "Twin_UpdateModuleTwin",
"operationId": "Modules_UpdateTwin",
"consumes": [
"application/json"
],
Expand Down Expand Up @@ -1157,7 +1157,7 @@
"get": {
"summary": "This method is used to retrieve feedback of a cloud-to-device message.",
"description": "This method is used to retrieve feedback for cloud-to-device messages. See https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging for more information. This capability is only available in the standard tier IoT Hub. For more information, see [Choose the right IoT Hub tier](https://aka.ms/scaleyouriotsolution).",
"operationId": "HttpRuntime_ReceiveFeedbackNotification",
"operationId": "CloudToDeviceMessages_ReceiveFeedbackNotification",
"consumes": [],
"produces": [
"application/json"
Expand All @@ -1181,7 +1181,7 @@
"delete": {
"summary": "This method completes a feedback message.",
"description": "This method completes a cloud-to-device feedback message. A completed message is deleted from the service's feedback queue. See https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging for more information.",
"operationId": "HttpRuntime_CompleteFeedbackNotification",
"operationId": "CloudToDeviceMessages_CompleteFeedbackNotification",
"consumes": [],
"produces": [
"application/json"
Expand Down Expand Up @@ -1209,7 +1209,7 @@
"post": {
"summary": "This method abandons a feedback message.",
"description": "This method abandons a cloud-to-device feedback message. An abandoned message is deleted from the service's feedback queue. See https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging for more information.",
"operationId": "HttpRuntime_AbandonFeedbackNotification",
"operationId": "CloudToDeviceMessages_AbandonFeedbackNotification",
"consumes": [],
"produces": [
"application/json"
Expand Down Expand Up @@ -1237,7 +1237,7 @@
"get": {
"summary": "Retrieves details of a scheduled job from an IoT hub.",
"description": "Retrieves details of a scheduled job from IoT hub. See https://docs.microsoft.com/en-us/azure/iot-hub/iot-hub-devguide-jobs for more information.",
"operationId": "JobClient_GetJob",
"operationId": "Jobs_Get",
"consumes": [],
"produces": [
"application/json"
Expand Down Expand Up @@ -1266,7 +1266,7 @@
"put": {
"summary": "Creates a new job to schedule update twins or device direct methods on an IoT hub at a scheduled time.",
"description": "Creates a new job to schedule twin updates or direct methods on IoT Hub at a scheduled time. See https://docs.microsoft.com/en-us/azure/iot-hub/iot-hub-devguide-jobs for more information.",
"operationId": "JobClient_CreateJob",
"operationId": "Jobs_Create",
bikamani marked this conversation as resolved.
Show resolved Hide resolved
"consumes": [
"application/json"
],
Expand Down Expand Up @@ -1308,7 +1308,7 @@
"post": {
"summary": "Cancels a scheduled job on an IoT hub.",
"description": "Cancels a scheduled job on IoT Hub. See https://docs.microsoft.com/en-us/azure/iot-hub/iot-hub-devguide-jobs for more information.",
"operationId": "JobClient_CancelJob",
"operationId": "Jobs_Cancel",
"consumes": [],
"produces": [
"application/json"
Expand Down Expand Up @@ -1339,7 +1339,7 @@
"get": {
"summary": "Query an IoT hub to retrieve information regarding jobs using the IoT Hub query language",
"description": "Query IoT hub to retrieve information regarding jobs using the IoT Hub query language. See https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-query-language for more information.",
"operationId": "JobClient_QueryJobs",
"operationId": "Jobs_Query",
bikamani marked this conversation as resolved.
Show resolved Hide resolved
"consumes": [],
"produces": [
"application/json"
Expand Down Expand Up @@ -1377,7 +1377,7 @@
"get": {
"summary": "Retrieve all the module identities on the device.",
"description": "Get all the module identities of the device.",
"operationId": "RegistryManager_GetModulesOnDevice",
"operationId": "Modules_GetModulesOnDevice",
"consumes": [],
"produces": [
"application/json"
Expand Down Expand Up @@ -1411,7 +1411,7 @@
"get": {
"summary": "Retrieve the specified module identity on the device.",
"description": "Get the specified module identity of the device.",
"operationId": "RegistryManager_GetModule",
"operationId": "Modules_GetIdentity",
"consumes": [],
"produces": [
"application/json"
Expand Down Expand Up @@ -1447,7 +1447,7 @@
"put": {
"summary": "Create or update the module identity for device in IoT hub. An ETag must not be specified for the create operation. An ETag must be specified for the update operation. Note that moduleId and generation cannot be updated by the user.",
"description": "Create or update the module identity for device in IoT hub. The moduleId and generation cannot be updated by the user.",
"operationId": "RegistryManager_CreateOrUpdateModule",
"operationId": "Modules_CreateOrUpdateIdentity",
"consumes": [
"application/json"
],
Expand Down Expand Up @@ -1507,7 +1507,7 @@
"delete": {
"summary": "Delete the module identity for device of an IoT hub. This request requires the If-Match header. The client may specify the ETag for the device identity on the request in order to compare to the ETag maintained by the service for the purpose of optimistic concurrency. The delete operation is performed only if the ETag sent by the client matches the value maintained by the server, indicating that the device identity has not been modified since it was retrieved by the client. To force an unconditional delete, set If-Match to the wildcard character (*).",
"description": "Delete the module identity for device of an IoT hub.",
"operationId": "RegistryManager_DeleteModule",
"operationId": "Modules_DeleteIdentity",
"consumes": [],
"produces": [
"application/json"
Expand Down Expand Up @@ -1626,7 +1626,7 @@
"post": {
"summary": "Invoke a direct method on a device.",
"description": "Invoke a direct method on a device. See https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-direct-methods for more information.",
"operationId": "DeviceMethod_InvokeDeviceMethod",
"operationId": "Devices_InvokeMethod",
"consumes": [
"application/json"
],
Expand Down Expand Up @@ -1668,7 +1668,7 @@
"post": {
"summary": "Invoke a direct method on a module of a device.",
"description": "Invoke a direct method on a module of a device. See https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-direct-methods for more information.",
"operationId": "DeviceMethod_InvokeModuleMethod",
"operationId": "Modules_InvokeMethod",
"consumes": [
"application/json"
],
Expand Down