[EdgeOrder] Update 2020-12-01-preview swagger with swagger correctnes…

…s 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 (Azure#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]>
niteshvijay1995 · Oct 12, 2021 · d12092e · d12092e
1 parent 53f959c
commit d12092e
Show file tree

Hide file tree

Showing 6 changed files with 154 additions and 23 deletions.
diff --git a/.../edgeorder/resource-manager/Microsoft.EdgeOrder/preview/2020-12-01-preview/edgeorder.json b/.../edgeorder/resource-manager/Microsoft.EdgeOrder/preview/2020-12-01-preview/edgeorder.json
@@ -354,7 +354,7 @@
         "tags": [
           "OrderItems"
         ],
-        "description": "Lists order at subscription level.",
+        "description": "Lists order item at subscription level.",
         "operationId": "ListOrderItemsAtSubscriptionLevel",
         "consumes": [
           "application/json"
@@ -376,17 +376,24 @@
             "required": false,
             "type": "string"
           },
+          {
+            "name": "$expand",
+            "in": "query",
+            "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.",
+            "required": false,
+            "type": "string"
+          },
           {
             "name": "$skipToken",
             "in": "query",
-            "description": "$skipToken is supported on Get list of orders, which provides the next page in the list of order.",
+            "description": "$skipToken is supported on Get list of order items, which provides the next page in the list of order items.",
             "required": false,
             "type": "string"
           }
         ],
         "responses": {
           "200": {
-            "description": "Order item object",
+            "description": "List of Order item object",
             "schema": {
               "$ref": "#/definitions/OrderItemResourceList"
             }
@@ -554,7 +561,7 @@
         ],
         "responses": {
           "200": {
-            "description": "Address object.",
+            "description": "Address resource object.",
             "schema": {
               "$ref": "#/definitions/AddressResource"
             }
@@ -832,7 +839,7 @@
           {
             "name": "$expand",
             "in": "query",
-            "description": "$expand is supported on device details parameter for order item, which provides details on the devices of the product.",
+            "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.",
             "required": false,
             "type": "string"
           },
@@ -897,7 +904,7 @@
           {
             "name": "$expand",
             "in": "query",
-            "description": "$expand is supported on device details parameter for order item, which provides details on the devices of the product.",
+            "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.",
             "required": false,
             "type": "string"
           }
@@ -1781,6 +1788,11 @@
           "description": "Management Resource Id",
           "type": "string",
           "readOnly": true
+        },
+        "managementResourceTenantId": {
+          "description": "Management Resource Tenant ID",
+          "type": "string",
+          "readOnly": true
         }
       }
     },
@@ -1887,7 +1899,7 @@
       "type": "object",
       "properties": {
         "doubleEncryptionStatus": {
-          "description": "Defines secondary layer of software-based encryption enablement.",
+          "description": "Double encryption status as entered by the customer. It is compulsory to give this parameter if the 'Deny' or 'Disabled' policy is configured.",
           "enum": [
             "Disabled",
             "Enabled"
@@ -1906,8 +1918,7 @@
                 "description": "Double encryption is enabled"
               }
             ]
-          },
-          "default": "Disabled"
+          }
         }
       }
     },
@@ -1951,6 +1962,32 @@
         }
       }
     },
+    "ForwardShippingDetails": {
+      "description": "Forward shipment details.",
+      "type": "object",
+      "properties": {
+        "carrierName": {
+          "description": "Name of the carrier.",
+          "type": "string",
+          "readOnly": true
+        },
+        "carrierDisplayName": {
+          "description": "Carrier Name for display purpose. Not to be used for any processing.",
+          "type": "string",
+          "readOnly": true
+        },
+        "trackingId": {
+          "description": "TrackingId of the package",
+          "type": "string",
+          "readOnly": true
+        },
+        "trackingUrl": {
+          "description": "TrackingUrl of the package.",
+          "type": "string",
+          "readOnly": true
+        }
+      }
+    },
     "HierarchyInformation": {
       "description": "Holds details about product hierarchy information",
       "type": "object",
@@ -2298,12 +2335,12 @@
           "description": "Customer notification Preferences"
         },
         "forwardShippingDetails": {
-          "$ref": "#/definitions/ShippingDetails",
+          "$ref": "#/definitions/ForwardShippingDetails",
           "description": "Forward Package Shipping details",
           "readOnly": true
         },
         "reverseShippingDetails": {
-          "$ref": "#/definitions/ShippingDetails",
+          "$ref": "#/definitions/ReverseShippingDetails",
           "description": "Reverse Package Shipping details",
           "readOnly": true
         },
@@ -2321,7 +2358,7 @@
           "readOnly": true
         },
         "cancellationStatus": {
-          "description": "Describes whether the orderItem is cancellable or not.",
+          "description": "Describes whether the order item is cancellable or not.",
           "enum": [
             "Cancellable",
             "CancellableWithFee",
@@ -2377,7 +2414,7 @@
           "readOnly": true
         },
         "returnStatus": {
-          "description": "Describes whether the orderItem is returnable or not.",
+          "description": "Describes whether the order item is returnable or not.",
           "enum": [
             "Returnable",
             "ReturnableWithFee",
@@ -2406,7 +2443,16 @@
         },
         "managementRpDetails": {
           "$ref": "#/definitions/ResourceProviderDetails",
-          "description": "parent RP details",
+          "description": "Parent RP details - this returns only the first or default parent RP from the entire list",
+          "readOnly": true
+        },
+        "managementRpDetailsList": {
+          "description": "List of parent RP details supported for configuration.",
+          "uniqueItems": false,
+          "type": "array",
+          "items": {
+            "$ref": "#/definitions/ResourceProviderDetails"
+          },
           "readOnly": true
         },
         "error": {
@@ -2737,7 +2783,31 @@
         "count": {
           "format": "int32",
           "description": "Quantity of the product",
-          "type": "integer"
+          "type": "integer",
+          "readOnly": true
+        },
+        "productDoubleEncryptionStatus": {
+          "description": "Double encryption status of the configuration. Read-only field.",
+          "enum": [
+            "Disabled",
+            "Enabled"
+          ],
+          "type": "string",
+          "readOnly": true,
+          "x-ms-enum": {
+            "name": "DoubleEncryptionStatus",
+            "modelAsString": true,
+            "values": [
+              {
+                "value": "Disabled",
+                "description": "Double encryption is disabled"
+              },
+              {
+                "value": "Enabled",
+                "description": "Double encryption is enabled"
+              }
+            ]
+          }
         },
         "deviceDetails": {
           "description": "list of device details",
@@ -2854,6 +2924,14 @@
             "$ref": "#/definitions/ProductLine"
           },
           "readOnly": true
+        },
+        "resourceProviderDetails": {
+          "description": "Contains details related to resource provider",
+          "uniqueItems": false,
+          "type": "array",
+          "items": {
+            "$ref": "#/definitions/ResourceProviderDetails"
+          }
         }
       }
     },
@@ -2962,7 +3040,13 @@
     "ResourceProviderDetails": {
       "description": "Management RP details",
       "type": "object",
-      "properties": {}
+      "properties": {
+        "resourceProviderNamespace": {
+          "description": "Resource provider namespace",
+          "type": "string",
+          "readOnly": true
+        }
+      }
     },
     "ReturnOrderItemDetails": {
       "description": "Return order item request body",
@@ -2978,6 +3062,46 @@
         "returnReason": {
           "description": "Return Reason.",
           "type": "string"
+        },
+        "serviceTag": {
+          "description": "Service tag (located on the bottom-right corner of the device)",
+          "type": "string"
+        },
+        "shippingBoxRequired": {
+          "description": "Shipping Box required",
+          "default": false,
+          "type": "boolean"
+        }
+      }
+    },
+    "ReverseShippingDetails": {
+      "description": "Reverse shipment details.",
+      "type": "object",
+      "properties": {
+        "sasKeyForLabel": {
+          "description": "SAS key to download the reverse shipment label of the package.",
+          "type": "string",
+          "readOnly": true
+        },
+        "carrierName": {
+          "description": "Name of the carrier.",
+          "type": "string",
+          "readOnly": true
+        },
+        "carrierDisplayName": {
+          "description": "Carrier Name for display purpose. Not to be used for any processing.",
+          "type": "string",
+          "readOnly": true
+        },
+        "trackingId": {
+          "description": "TrackingId of the package",
+          "type": "string",
+          "readOnly": true
+        },
+        "trackingUrl": {
+          "description": "TrackingUrl of the package.",
+          "type": "string",
+          "readOnly": true
         }
       }
     },

diff --git a/...urce-manager/Microsoft.EdgeOrder/preview/2020-12-01-preview/examples/CreateOrderItem.json b/...urce-manager/Microsoft.EdgeOrder/preview/2020-12-01-preview/examples/CreateOrderItem.json
@@ -82,7 +82,8 @@
                 "productName": "azurestackedgegpu",
                 "configurationName": "azurestackedgegpu"
               },
-              "count": 0
+              "count": 0,
+              "productDoubleEncryptionStatus": "Disabled"
             },
             "orderItemType": "Purchase",
             "currentStage": {

diff --git a/...e-manager/Microsoft.EdgeOrder/preview/2020-12-01-preview/examples/GetOrderItemByName.json b/...e-manager/Microsoft.EdgeOrder/preview/2020-12-01-preview/examples/GetOrderItemByName.json
@@ -27,7 +27,8 @@
                 "productName": "azurestackedgegpu",
                 "configurationName": "azurestackedgegpu"
               },
-              "count": 0
+              "count": 0,
+              "productDoubleEncryptionStatus": "Disabled"
             },
             "orderItemType": "Purchase",
             "currentStage": {

diff --git a/...oft.EdgeOrder/preview/2020-12-01-preview/examples/ListOrderItemsAtResourceGroupLevel.json b/...oft.EdgeOrder/preview/2020-12-01-preview/examples/ListOrderItemsAtResourceGroupLevel.json
@@ -28,7 +28,8 @@
                     "productName": "azurestackedgegpu",
                     "configurationName": "azurestackedgegpu"
                   },
-                  "count": 0
+                  "count": 0,
+                  "productDoubleEncryptionStatus": "Disabled"
                 },
                 "orderItemType": "Purchase",
                 "currentStage": {
@@ -122,7 +123,8 @@
                     "productName": "azurestackedgegpu",
                     "configurationName": "azurestackedgegpu"
                   },
-                  "count": 0
+                  "count": 0,
+                  "productDoubleEncryptionStatus": "Disabled"
                 },
                 "orderItemType": "Purchase",
                 "currentStage": {

diff --git a/...soft.EdgeOrder/preview/2020-12-01-preview/examples/ListOrderItemsAtSubscriptionLevel.json b/...soft.EdgeOrder/preview/2020-12-01-preview/examples/ListOrderItemsAtSubscriptionLevel.json
@@ -27,7 +27,8 @@
                     "productName": "azurestackedgegpu",
                     "configurationName": "azurestackedgegpu"
                   },
-                  "count": 0
+                  "count": 0,
+                  "productDoubleEncryptionStatus": "Disabled"
                 },
                 "orderItemType": "Purchase",
                 "currentStage": {
@@ -120,7 +121,8 @@
                     "productName": "azurestackedgegpu",
                     "configurationName": "azurestackedgegpu"
                   },
-                  "count": 0
+                  "count": 0,
+                  "productDoubleEncryptionStatus": "Disabled"
                 },
                 "orderItemType": "Purchase",
                 "currentStage": {

diff --git a/...urce-manager/Microsoft.EdgeOrder/preview/2020-12-01-preview/examples/UpdateOrderItem.json b/...urce-manager/Microsoft.EdgeOrder/preview/2020-12-01-preview/examples/UpdateOrderItem.json
@@ -56,7 +56,8 @@
                 "productName": "azurestackedgegpu",
                 "configurationName": "azurestackedgegpu"
               },
-              "count": 0
+              "count": 0,
+              "productDoubleEncryptionStatus": "Disabled"
             },
             "orderItemType": "Purchase",
             "currentStage": {