Skip to content

Commit d12092e

Browse files
vaishnavi-janardhansashanmt-vjanardhannija-dev
authored
[EdgeOrder] Update 2020-12-01-preview swagger with swagger correctness fix and other changes (Azure#15962)
* new api changes (#1) * new api changes * referer url change * EdgeOrder 2020-12-01-preview Swagger changes (#5) * readme changes * Swagger refresh and update examples * Change examples as per oav validations * Minor swagger modifications * Minor spacing adjustments * Set ModelAsString to true for enums and modify examples * Fix swagger lint validation error * Modify readme and examples * Modify readme.go.md * Update swagger * Minor prettier fix * Change python package version in readme * Fix spell check error * chanegs to enable forward and reverse shipping details in get order item call using odata filter * 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 <[email protected]> * Fix semantic validation error in doubleEncryptionStatus (Azure#30) * Mark parameters of shipping details as readonly (Azure#35) * Additional properties swagger correctness fix (Azure#43) Co-authored-by: sashanm <[email protected]> Co-authored-by: t-vjanardhan <[email protected]> Co-authored-by: Nidhi Jain <[email protected]> Co-authored-by: nija-dev <[email protected]> Co-authored-by: Vaishnavi Janardhan <[email protected]>
1 parent 53f959c commit d12092e

File tree

6 files changed

+154
-23
lines changed

6 files changed

+154
-23
lines changed

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

Lines changed: 140 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -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"
@@ -1906,8 +1918,7 @@
19061918
"description": "Double encryption is enabled"
19071919
}
19081920
]
1909-
},
1910-
"default": "Disabled"
1921+
}
19111922
}
19121923
}
19131924
},
@@ -1951,6 +1962,32 @@
19511962
}
19521963
}
19531964
},
1965+
"ForwardShippingDetails": {
1966+
"description": "Forward shipment details.",
1967+
"type": "object",
1968+
"properties": {
1969+
"carrierName": {
1970+
"description": "Name of the carrier.",
1971+
"type": "string",
1972+
"readOnly": true
1973+
},
1974+
"carrierDisplayName": {
1975+
"description": "Carrier Name for display purpose. Not to be used for any processing.",
1976+
"type": "string",
1977+
"readOnly": true
1978+
},
1979+
"trackingId": {
1980+
"description": "TrackingId of the package",
1981+
"type": "string",
1982+
"readOnly": true
1983+
},
1984+
"trackingUrl": {
1985+
"description": "TrackingUrl of the package.",
1986+
"type": "string",
1987+
"readOnly": true
1988+
}
1989+
}
1990+
},
19541991
"HierarchyInformation": {
19551992
"description": "Holds details about product hierarchy information",
19561993
"type": "object",
@@ -2298,12 +2335,12 @@
22982335
"description": "Customer notification Preferences"
22992336
},
23002337
"forwardShippingDetails": {
2301-
"$ref": "#/definitions/ShippingDetails",
2338+
"$ref": "#/definitions/ForwardShippingDetails",
23022339
"description": "Forward Package Shipping details",
23032340
"readOnly": true
23042341
},
23052342
"reverseShippingDetails": {
2306-
"$ref": "#/definitions/ShippingDetails",
2343+
"$ref": "#/definitions/ReverseShippingDetails",
23072344
"description": "Reverse Package Shipping details",
23082345
"readOnly": true
23092346
},
@@ -2321,7 +2358,7 @@
23212358
"readOnly": true
23222359
},
23232360
"cancellationStatus": {
2324-
"description": "Describes whether the orderItem is cancellable or not.",
2361+
"description": "Describes whether the order item is cancellable or not.",
23252362
"enum": [
23262363
"Cancellable",
23272364
"CancellableWithFee",
@@ -2377,7 +2414,7 @@
23772414
"readOnly": true
23782415
},
23792416
"returnStatus": {
2380-
"description": "Describes whether the orderItem is returnable or not.",
2417+
"description": "Describes whether the order item is returnable or not.",
23812418
"enum": [
23822419
"Returnable",
23832420
"ReturnableWithFee",
@@ -2406,7 +2443,16 @@
24062443
},
24072444
"managementRpDetails": {
24082445
"$ref": "#/definitions/ResourceProviderDetails",
2409-
"description": "parent RP details",
2446+
"description": "Parent RP details - this returns only the first or default parent RP from the entire list",
2447+
"readOnly": true
2448+
},
2449+
"managementRpDetailsList": {
2450+
"description": "List of parent RP details supported for configuration.",
2451+
"uniqueItems": false,
2452+
"type": "array",
2453+
"items": {
2454+
"$ref": "#/definitions/ResourceProviderDetails"
2455+
},
24102456
"readOnly": true
24112457
},
24122458
"error": {
@@ -2737,7 +2783,31 @@
27372783
"count": {
27382784
"format": "int32",
27392785
"description": "Quantity of the product",
2740-
"type": "integer"
2786+
"type": "integer",
2787+
"readOnly": true
2788+
},
2789+
"productDoubleEncryptionStatus": {
2790+
"description": "Double encryption status of the configuration. Read-only field.",
2791+
"enum": [
2792+
"Disabled",
2793+
"Enabled"
2794+
],
2795+
"type": "string",
2796+
"readOnly": true,
2797+
"x-ms-enum": {
2798+
"name": "DoubleEncryptionStatus",
2799+
"modelAsString": true,
2800+
"values": [
2801+
{
2802+
"value": "Disabled",
2803+
"description": "Double encryption is disabled"
2804+
},
2805+
{
2806+
"value": "Enabled",
2807+
"description": "Double encryption is enabled"
2808+
}
2809+
]
2810+
}
27412811
},
27422812
"deviceDetails": {
27432813
"description": "list of device details",
@@ -2854,6 +2924,14 @@
28542924
"$ref": "#/definitions/ProductLine"
28552925
},
28562926
"readOnly": true
2927+
},
2928+
"resourceProviderDetails": {
2929+
"description": "Contains details related to resource provider",
2930+
"uniqueItems": false,
2931+
"type": "array",
2932+
"items": {
2933+
"$ref": "#/definitions/ResourceProviderDetails"
2934+
}
28572935
}
28582936
}
28592937
},
@@ -2962,7 +3040,13 @@
29623040
"ResourceProviderDetails": {
29633041
"description": "Management RP details",
29643042
"type": "object",
2965-
"properties": {}
3043+
"properties": {
3044+
"resourceProviderNamespace": {
3045+
"description": "Resource provider namespace",
3046+
"type": "string",
3047+
"readOnly": true
3048+
}
3049+
}
29663050
},
29673051
"ReturnOrderItemDetails": {
29683052
"description": "Return order item request body",
@@ -2978,6 +3062,46 @@
29783062
"returnReason": {
29793063
"description": "Return Reason.",
29803064
"type": "string"
3065+
},
3066+
"serviceTag": {
3067+
"description": "Service tag (located on the bottom-right corner of the device)",
3068+
"type": "string"
3069+
},
3070+
"shippingBoxRequired": {
3071+
"description": "Shipping Box required",
3072+
"default": false,
3073+
"type": "boolean"
3074+
}
3075+
}
3076+
},
3077+
"ReverseShippingDetails": {
3078+
"description": "Reverse shipment details.",
3079+
"type": "object",
3080+
"properties": {
3081+
"sasKeyForLabel": {
3082+
"description": "SAS key to download the reverse shipment label of the package.",
3083+
"type": "string",
3084+
"readOnly": true
3085+
},
3086+
"carrierName": {
3087+
"description": "Name of the carrier.",
3088+
"type": "string",
3089+
"readOnly": true
3090+
},
3091+
"carrierDisplayName": {
3092+
"description": "Carrier Name for display purpose. Not to be used for any processing.",
3093+
"type": "string",
3094+
"readOnly": true
3095+
},
3096+
"trackingId": {
3097+
"description": "TrackingId of the package",
3098+
"type": "string",
3099+
"readOnly": true
3100+
},
3101+
"trackingUrl": {
3102+
"description": "TrackingUrl of the package.",
3103+
"type": "string",
3104+
"readOnly": true
29813105
}
29823106
}
29833107
},

‎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)