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

Microsoft.DataBoxEdge RP: Corrected comments of trigger and extendedinfo APIs, corrected examples #5322

Merged
merged 3 commits into from
Mar 12, 2019
Merged

Microsoft.DataBoxEdge RP: Corrected comments of trigger and extendedinfo APIs, corrected examples #5322

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
48ab04d
Corrected comments of trigger and extendedinfo APIs, corrected examples
anponnet Mar 5, 2019
a412196
Microsoft.DataBoxEdge RP: Have better examples
anponnet Mar 5, 2019
86db25b
Corrected parameter description in order API
anponnet Mar 6, 2019
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
61 changes: 12 additions & 49 deletions ...ion/edgegateway/resource-manager/Microsoft.DataBoxEdge/stable/2019-03-01/edgegateway.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -520,45 +520,6 @@
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/getExtendedInformation": {
Copy link
Contributor

Choose a reason for hiding this comment

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

@anponnet - Has this API ever worked? It couldn't have since the URL is not well-formed as per ARM guideline. Was the PUT added by accident to swagger? Or do you actually have a PUT for this path?
I checked the calls to this API and there is no traffic to this path in the last 45 days.
Please confirm and then we can sign off. Even though theoretically its breaking change for the SDK, but my hunch is that it never would have worked. And so it may be ok.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

@ravbhatnagar , We had a PUT call on this path when we released our private preview which was not reviewed by ARM. Later on this API was removed and it is never in use. So there wont be any call to that API. Though API was removed, the Path was part of swagger and it went in our last swagger release. Our SDK (or even API documentation) is not yet released, so it is safe to remove this

Copy link
Contributor

Choose a reason for hiding this comment

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

Sounds good and thanks for confirming. @praries880 - this should be good to remove.

"put": {
"tags": [ "Devices" ],
"description": "Creates or updates the additional information of a the data box edge/gateway device.",
"operationId": "Devices_CreateOrUpdateExtendedInfo",
"parameters": [
{
"name": "deviceName",
"in": "path",
"description": "The device name.",
"required": true,
"type": "string"
},
{
"name": "parameters",
"in": "body",
"description": "The additional information.",
"required": true,
"schema": { "$ref": "#/definitions/DataBoxEdgeDeviceExtendedInfo" }
},
{ "$ref": "#/parameters/subscriptionIdParameter" },
{ "$ref": "#/parameters/resourceGroupNameParameter" },
{ "$ref": "#/parameters/apiVersionParameter" }
],
"responses": {
"200": {
"description": "Successfully created/updated the additional information on the device.",
"schema": { "$ref": "#/definitions/DataBoxEdgeDeviceExtendedInfo" }
},
"default": {
"description": "Error response describing why the operation failed.",
"schema": { "$ref": "#/definitions/CloudError" }
}
},
"x-ms-examples": {
"ExtendedInfoPut": {
"$ref": "./examples/ExtendedInfoPut.json"
}
}
},
"post": {
"tags": [ "Devices" ],
"description": "Gets additional information for the specified data box edge/gateway device.",
Expand Down Expand Up @@ -817,7 +778,7 @@
{
"name": "deviceName",
"in": "path",
"description": "The order details of a device.",
"description": "The device name.",
"required": true,
"type": "string"
},
Expand Down Expand Up @@ -1500,7 +1461,14 @@
},
{ "$ref": "#/parameters/subscriptionIdParameter" },
{ "$ref": "#/parameters/resourceGroupNameParameter" },
{ "$ref": "#/parameters/apiVersionParameter" }
{ "$ref": "#/parameters/apiVersionParameter" },
{
"name": "$expand",
"in": "query",
"description": "Specify $filter='CustomContextTag eq <tag>' to filter on custom context tag property",
"required": false,
"type": "string"
}
],
"responses": {
"200": {
Expand Down Expand Up @@ -2283,19 +2251,14 @@
},
"DataBoxEdgeDeviceExtendedInfoProperties": {
"description": "The properties of the Data Box Edge/Gateway device extended info.",
"required": [ "integrityKey" ],
"type": "object",
"properties": {
"integrityKey": {
"description": "The Channel Integrity Key (CIK) of the device.",
"type": "string"
},
"encryptionKeyThumbprint": {
"description": "The certificate thumbprint that was used to encrypt the Channel Integrity Key (CIK).",
"description": "The digital signature of encrypted certificate.",
"type": "string"
},
"encryptionKey": {
"description": "The Channel Integrity Key (CIK) of the device.",
"description": "The public part of the encryption certificate. Client uses this to encrypt any secret.",
"type": "string"
},
"resourceKey": {
Expand Down Expand Up @@ -3265,7 +3228,7 @@
"properties": {
"startTime": {
"format": "date-time",
"description": "The time of the day that results in a valid trigger. Schedule is computed with reference to the time specified.",
"description": "The time of the day that results in a valid trigger. Schedule is computed with reference to the time specified upto seconds. If timezone is not specified the time will considered to be in device timezone. The value will always be returned as UTC time.",
"type": "string"
},
"schedule": {
Expand Down
6 changes: 4 additions & 2 deletions ...y/resource-manager/Microsoft.DataBoxEdge/stable/2019-03-01/examples/ExtendedInfoPost.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,8 +21,10 @@
"200": {
"body": {
"properties": {
"integrityKey": "Test-integrity-key",
"resourceKey": "3482840729935603111"
"resourceKey": "3482840729935603111",
"encryptionKeyThumbprint": "<encryptionthumbprint>",
"encryptionKey": "<encryptionkey>"

},
"id": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/testedgedevice",
"name": "testedgedevice",
Expand Down
41 changes: 0 additions & 41 deletions ...ay/resource-manager/Microsoft.DataBoxEdge/stable/2019-03-01/examples/ExtendedInfoPut.json
View file
Open in desktop

This file was deleted.

2 changes: 1 addition & 1 deletion ...ateway/resource-manager/Microsoft.DataBoxEdge/stable/2019-03-01/examples/ShareDelete.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
"subscriptionId": "4385cf00-2d3a-425a-832f-f4285b1c9dce",
"resourceGroupName": "GroupForEdgeAutomation",
"deviceName": "testedgedevice",
"name": "testShare1234SMB",
"name": "smbshare",
"x-ms-client-request-id": [
"a93b39a3-1ff4-42b8-a56f-43368d47e37a"
],
Expand Down
8 changes: 4 additions & 4 deletions ...gegateway/resource-manager/Microsoft.DataBoxEdge/stable/2019-03-01/examples/ShareGet.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
"subscriptionId": "4385cf00-2d3a-425a-832f-f4285b1c9dce",
"resourceGroupName": "GroupForEdgeAutomation",
"deviceName": "testedgedevice",
"name": "testShare1234SMB",
"name": "smbshare",
"x-ms-client-request-id": [
"a93b39a3-1ff4-42b8-a56f-43368d47e37a"
],
Expand All @@ -20,7 +20,7 @@
"shareStatus": "Online",
"monitoringStatus": "Disabled",
"azureContainerInfo": {
"storageAccountCredentialId": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/EAuToWIN-2FO5M5SFCEN1218180610041/storageAccountCredentials/sac1218180610052",
"storageAccountCredentialId": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/testedgedevice/storageAccountCredentials/sac1",
"containerName": "testContainerSMB",
"dataFormat": "BlockBlob"
},
Expand All @@ -36,8 +36,8 @@
"shareMappings": [],
"dataPolicy": "Cloud"
},
"id": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/testedgedevice/shares/testShare1234SMB",
"name": "testShare1234SMB",
"id": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/testedgedevice/shares/smbshare",
"name": "smbshare",
"type": "dataBoxEdgeDevices/shares"
}
}
Expand Down
6 changes: 3 additions & 3 deletions ...esource-manager/Microsoft.DataBoxEdge/stable/2019-03-01/examples/ShareGetAllInDevice.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@
"shareStatus": "Online",
"monitoringStatus": "Disabled",
"azureContainerInfo": {
"storageAccountCredentialId": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/EAuToWIN-2FO5M5SFCEN1218180610041/storageAccountCredentials/sac1218180610052",
"storageAccountCredentialId": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/testedgedevice/storageAccountCredentials/sac1",
"containerName": "testContainerSMB",
"dataFormat": "BlockBlob"
},
Expand All @@ -37,8 +37,8 @@
"shareMappings": [],
"dataPolicy": "Cloud"
},
"id": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/testedgedevice/shares/testShare1234SMB",
"name": "testShare1234SMB",
"id": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/testedgedevice/shares/smbshare",
"name": "smbshare",
"type": "dataBoxEdgeDevices/shares"
}
]
Expand Down
12 changes: 6 additions & 6 deletions ...gegateway/resource-manager/Microsoft.DataBoxEdge/stable/2019-03-01/examples/SharePut.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
"subscriptionId": "4385cf00-2d3a-425a-832f-f4285b1c9dce",
"resourceGroupName": "GroupForEdgeAutomation",
"deviceName": "testedgedevice",
"name": "testShare1234SMB",
"name": "smbshare",

"Content-Type": [
"application/json; charset=utf-8"
Expand All @@ -24,7 +24,7 @@
"shareStatus": "Online",
"monitoringStatus": "Enabled",
"azureContainerInfo": {
"storageAccountCredentialId": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/EAuToWIN-2FO5M5SFCEN1218180610041/storageAccountCredentials/sac1218180610052",
"storageAccountCredentialId": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/testedgedevice/storageAccountCredentials/sac1",
"containerName": "testContainerSMB",
"dataFormat": "BlockBlob"
},
Expand All @@ -37,7 +37,7 @@
],
"dataPolicy": "Cloud"
},
"name": "testShare1234SMB"
"name": "smbshare"
}
},
"responses": {
Expand All @@ -48,7 +48,7 @@
"shareStatus": "Online",
"monitoringStatus": "Disabled",
"azureContainerInfo": {
"storageAccountCredentialId": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/EAuToWIN-2FO5M5SFCEN1218180610041/storageAccountCredentials/sac1218180610052",
"storageAccountCredentialId": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/testedgedevice/storageAccountCredentials/sac1",
"containerName": "testContainerSMB",
"dataFormat": "BlockBlob"
},
Expand All @@ -64,8 +64,8 @@
"shareMappings": [],
"dataPolicy": "Cloud"
},
"id": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/testedgedevice/shares/testShare1234SMB",
"name": "testShare1234SMB",
"id": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/testedgedevice/shares/smbshare",
"name": "smbshare",
"type": "dataBoxEdgeDevices/shares"
}
},
Expand Down
2 changes: 1 addition & 1 deletion ...y/resource-manager/Microsoft.DataBoxEdge/stable/2019-03-01/examples/ShareRefreshPost.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
"subscriptionId": "4385cf00-2d3a-425a-832f-f4285b1c9dce",
"resourceGroupName": "GroupForEdgeAutomation",
"deviceName": "testedgedevice",
"name": "testShare1",
"name": "smbshare",

"Content-Type": [
"application/json; charset=utf-8"
Expand Down