Skip to content

Commit 8d27682

Browse files
vaishnavi-janardhanvaishnavi-janardhan
authored
Swagger correctness fix with other changes (#25)
* Swagger correctness fix with other changes * Return api field additions * Change expand description for listOrderItem calls Co-authored-by: Vaishnavi Janardhan <vjanardhan@microsoft.com>
1 parent 2c40871 commit 8d27682

File tree

6 files changed

+71
-18
lines changed

6 files changed

+71
-18
lines changed

‎specification/edgeorder/resource-manager/Microsoft.EdgeOrder/preview/2020-12-01-preview/edgeorder.json‎

Lines changed: 57 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -139,7 +139,7 @@
139139
{
140140
"name": "$expand",
141141
"in": "query",
142-
"description": "$expand is supported on device details, forward shipping details and reverse shipping details parameters. Each of these can be provided as a comma separated list. Device Details for order item provides details on the devices of the product, Forward and Reverse Shipping details provide forward and reverse shipping details respectively.",
142+
"description": "$expand is supported on configurations parameter for product, which provides details on the configurations for the product.",
143143
"required": false,
144144
"type": "string"
145145
},
@@ -354,7 +354,7 @@
354354
"tags": [
355355
"OrderItems"
356356
],
357-
"description": "Lists order at subscription level.",
357+
"description": "Lists order item at subscription level.",
358358
"operationId": "ListOrderItemsAtSubscriptionLevel",
359359
"consumes": [
360360
"application/json"
@@ -376,17 +376,24 @@
376376
"required": false,
377377
"type": "string"
378378
},
379+
{
380+
"name": "$expand",
381+
"in": "query",
382+
"description": "$expand is supported on device details, forward shipping details and reverse shipping details parameters. Each of these can be provided as a comma separated list. Device Details for order item provides details on the devices of the product, Forward and Reverse Shipping details provide forward and reverse shipping details respectively.",
383+
"required": false,
384+
"type": "string"
385+
},
379386
{
380387
"name": "$skipToken",
381388
"in": "query",
382-
"description": "$skipToken is supported on Get list of orders, which provides the next page in the list of order.",
389+
"description": "$skipToken is supported on Get list of order items, which provides the next page in the list of order items.",
383390
"required": false,
384391
"type": "string"
385392
}
386393
],
387394
"responses": {
388395
"200": {
389-
"description": "Order item object",
396+
"description": "List of Order item object",
390397
"schema": {
391398
"$ref": "#/definitions/OrderItemResourceList"
392399
}
@@ -554,7 +561,7 @@
554561
],
555562
"responses": {
556563
"200": {
557-
"description": "Address object.",
564+
"description": "Address resource object.",
558565
"schema": {
559566
"$ref": "#/definitions/AddressResource"
560567
}
@@ -832,7 +839,7 @@
832839
{
833840
"name": "$expand",
834841
"in": "query",
835-
"description": "$expand is supported on device details parameter for order item, which provides details on the devices of the product.",
842+
"description": "$expand is supported on device details, forward shipping details and reverse shipping details parameters. Each of these can be provided as a comma separated list. Device Details for order item provides details on the devices of the product, Forward and Reverse Shipping details provide forward and reverse shipping details respectively.",
836843
"required": false,
837844
"type": "string"
838845
},
@@ -897,7 +904,7 @@
897904
{
898905
"name": "$expand",
899906
"in": "query",
900-
"description": "$expand is supported on device details parameter for order item, which provides details on the devices of the product.",
907+
"description": "$expand is supported on device details, forward shipping details and reverse shipping details parameters. Each of these can be provided as a comma separated list. Device Details for order item provides details on the devices of the product, Forward and Reverse Shipping details provide forward and reverse shipping details respectively.",
901908
"required": false,
902909
"type": "string"
903910
}
@@ -1781,6 +1788,11 @@
17811788
"description": "Management Resource Id",
17821789
"type": "string",
17831790
"readOnly": true
1791+
},
1792+
"managementResourceTenantId": {
1793+
"description": "Management Resource Tenant ID",
1794+
"type": "string",
1795+
"readOnly": true
17841796
}
17851797
}
17861798
},
@@ -1887,7 +1899,7 @@
18871899
"type": "object",
18881900
"properties": {
18891901
"doubleEncryptionStatus": {
1890-
"description": "Defines secondary layer of software-based encryption enablement.",
1902+
"description": "Double encryption status as entered by the customer. It is compulsory to give this parameter if the 'Deny' or 'Disabled' policy is configured.",
18911903
"enum": [
18921904
"Disabled",
18931905
"Enabled"
@@ -2343,7 +2355,7 @@
23432355
"readOnly": true
23442356
},
23452357
"cancellationStatus": {
2346-
"description": "Describes whether the orderItem is cancellable or not.",
2358+
"description": "Describes whether the order item is cancellable or not.",
23472359
"enum": [
23482360
"Cancellable",
23492361
"CancellableWithFee",
@@ -2399,7 +2411,7 @@
23992411
"readOnly": true
24002412
},
24012413
"returnStatus": {
2402-
"description": "Describes whether the orderItem is returnable or not.",
2414+
"description": "Describes whether the order item is returnable or not.",
24032415
"enum": [
24042416
"Returnable",
24052417
"ReturnableWithFee",
@@ -2759,7 +2771,32 @@
27592771
"count": {
27602772
"format": "int32",
27612773
"description": "Quantity of the product",
2762-
"type": "integer"
2774+
"type": "integer",
2775+
"readOnly": true
2776+
},
2777+
"productDoubleEncryptionStatus": {
2778+
"description": "Double encryption status of the configuration. Read-only field.",
2779+
"enum": [
2780+
"Disabled",
2781+
"Enabled"
2782+
],
2783+
"type": "string",
2784+
"readOnly": true,
2785+
"x-ms-enum": {
2786+
"name": "DoubleEncryptionStatus",
2787+
"modelAsString": true,
2788+
"values": [
2789+
{
2790+
"value": "Disabled",
2791+
"description": "Double encryption is disabled"
2792+
},
2793+
{
2794+
"value": "Enabled",
2795+
"description": "Double encryption is enabled"
2796+
}
2797+
]
2798+
},
2799+
"default": "Disabled"
27632800
},
27642801
"deviceDetails": {
27652802
"description": "list of device details",
@@ -3000,6 +3037,15 @@
30003037
"returnReason": {
30013038
"description": "Return Reason.",
30023039
"type": "string"
3040+
},
3041+
"serviceTag": {
3042+
"description": "Service tag (located on the bottom-right corner of the device)",
3043+
"type": "string"
3044+
},
3045+
"shippingBoxRequired": {
3046+
"description": "Shipping Box required",
3047+
"default": false,
3048+
"type": "boolean"
30033049
}
30043050
}
30053051
},

‎specification/edgeorder/resource-manager/Microsoft.EdgeOrder/preview/2020-12-01-preview/examples/CreateOrderItem.json‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -82,7 +82,8 @@
8282
"productName": "azurestackedgegpu",
8383
"configurationName": "azurestackedgegpu"
8484
},
85-
"count": 0
85+
"count": 0,
86+
"productDoubleEncryptionStatus": "Disabled"
8687
},
8788
"orderItemType": "Purchase",
8889
"currentStage": {

‎specification/edgeorder/resource-manager/Microsoft.EdgeOrder/preview/2020-12-01-preview/examples/GetOrderItemByName.json‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,8 @@
2727
"productName": "azurestackedgegpu",
2828
"configurationName": "azurestackedgegpu"
2929
},
30-
"count": 0
30+
"count": 0,
31+
"productDoubleEncryptionStatus": "Disabled"
3132
},
3233
"orderItemType": "Purchase",
3334
"currentStage": {

‎specification/edgeorder/resource-manager/Microsoft.EdgeOrder/preview/2020-12-01-preview/examples/ListOrderItemsAtResourceGroupLevel.json‎

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,8 @@
2828
"productName": "azurestackedgegpu",
2929
"configurationName": "azurestackedgegpu"
3030
},
31-
"count": 0
31+
"count": 0,
32+
"productDoubleEncryptionStatus": "Disabled"
3233
},
3334
"orderItemType": "Purchase",
3435
"currentStage": {
@@ -122,7 +123,8 @@
122123
"productName": "azurestackedgegpu",
123124
"configurationName": "azurestackedgegpu"
124125
},
125-
"count": 0
126+
"count": 0,
127+
"productDoubleEncryptionStatus": "Disabled"
126128
},
127129
"orderItemType": "Purchase",
128130
"currentStage": {

‎specification/edgeorder/resource-manager/Microsoft.EdgeOrder/preview/2020-12-01-preview/examples/ListOrderItemsAtSubscriptionLevel.json‎

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,8 @@
2727
"productName": "azurestackedgegpu",
2828
"configurationName": "azurestackedgegpu"
2929
},
30-
"count": 0
30+
"count": 0,
31+
"productDoubleEncryptionStatus": "Disabled"
3132
},
3233
"orderItemType": "Purchase",
3334
"currentStage": {
@@ -120,7 +121,8 @@
120121
"productName": "azurestackedgegpu",
121122
"configurationName": "azurestackedgegpu"
122123
},
123-
"count": 0
124+
"count": 0,
125+
"productDoubleEncryptionStatus": "Disabled"
124126
},
125127
"orderItemType": "Purchase",
126128
"currentStage": {

‎specification/edgeorder/resource-manager/Microsoft.EdgeOrder/preview/2020-12-01-preview/examples/UpdateOrderItem.json‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -56,7 +56,8 @@
5656
"productName": "azurestackedgegpu",
5757
"configurationName": "azurestackedgegpu"
5858
},
59-
"count": 0
59+
"count": 0,
60+
"productDoubleEncryptionStatus": "Disabled"
6061
},
6162
"orderItemType": "Purchase",
6263
"currentStage": {

0 commit comments

Comments
 (0)