Swagger completeness for Redis Cache (Azure#2537)

* Default string modeled as parameter for auto generation to work correctly * Adding CheckNameAvailability and listUpgradeNotifications into swagger for redis * Fixing code review comments * remove "/" at end for list apis * Name change for notification * Fixing code review comments in PR * Fixing examples that are breaking the build
biberli · Mar 2, 2018 · 955331e · 955331e
1 parent 1fed5b4
commit 955331e
Show file tree

Hide file tree

Showing 6 changed files with 221 additions and 3 deletions.
diff --git a/...e-manager/Microsoft.Cache/stable/2017-10-01/examples/RedisCacheCheckNameAvailability.json b/...e-manager/Microsoft.Cache/stable/2017-10-01/examples/RedisCacheCheckNameAvailability.json
@@ -0,0 +1,13 @@
+{
+  "parameters": {
+    "api-version": "2017-10-01",
+    "subscriptionId": "subid",
+    "parameters": {
+      "type": "Microsoft.Cache/Redis",
+      "name": "cacheName"
+    }
+  },
+  "responses": {
+    "200": {}
+  }
+}
diff --git a/...anager/Microsoft.Cache/stable/2017-10-01/examples/RedisCacheListUpgradeNotifications.json b/...anager/Microsoft.Cache/stable/2017-10-01/examples/RedisCacheListUpgradeNotifications.json
@@ -0,0 +1,22 @@
+{
+  "parameters": {
+    "name": "cache1",
+    "resourceGroupName": "rg1",
+    "api-version": "2017-10-01",
+    "subscriptionId": "subid",
+    "history": "5000"
+  },
+  "responses": {
+    "200": {
+      "body": {
+        "value": [
+          {
+            "name": "notification1",
+            "timestamp": "2017-02-16T23:20:50.52Z",
+            "upsellNotification": {}
+          }
+        ]
+      }
+    }
+  }
+}
diff --git a/...er/Microsoft.Cache/stable/2017-10-01/examples/RedisCachePatchSchedulesCreateOrUpdate.json b/...er/Microsoft.Cache/stable/2017-10-01/examples/RedisCachePatchSchedulesCreateOrUpdate.json
@@ -2,6 +2,7 @@
   "parameters": {
     "name": "cache1",
     "resourceGroupName": "rg1",
+    "default": "default",
     "api-version": "2017-10-01",
     "subscriptionId": "subid",
     "parameters": {

diff --git a/...ce-manager/Microsoft.Cache/stable/2017-10-01/examples/RedisCachePatchSchedulesDelete.json b/...ce-manager/Microsoft.Cache/stable/2017-10-01/examples/RedisCachePatchSchedulesDelete.json
@@ -2,6 +2,7 @@
   "parameters": {
     "name": "cache1",
     "resourceGroupName": "rg1",
+    "default": "default",
     "api-version": "2017-10-01",
     "subscriptionId": "subid"
   },

diff --git a/...ource-manager/Microsoft.Cache/stable/2017-10-01/examples/RedisCachePatchSchedulesGet.json b/...ource-manager/Microsoft.Cache/stable/2017-10-01/examples/RedisCachePatchSchedulesGet.json
@@ -2,6 +2,7 @@
   "parameters": {
     "name": "cache1",
     "resourceGroupName": "rg1",
+    "default": "default",
     "api-version": "2017-10-01",
     "subscriptionId": "subid"
   },

diff --git a/specification/redis/resource-manager/Microsoft.Cache/stable/2017-10-01/redis.json b/specification/redis/resource-manager/Microsoft.Cache/stable/2017-10-01/redis.json
@@ -59,6 +59,90 @@
         }
       }
     },
+    "/subscriptions/{subscriptionId}/providers/Microsoft.Cache/CheckNameAvailability": {
+      "post": {
+        "tags": [
+          "Redis"
+        ],
+        "operationId": "Redis_CheckNameAvailability",
+        "x-ms-examples": {
+          "RedisCacheList": { "$ref": "./examples/RedisCacheCheckNameAvailability.json" }
+        },
+        "description": "Checks that the redis cache name is valid and is not already in use.",
+        "parameters": [
+          {
+            "name": "parameters",
+            "in": "body",
+            "required": true,
+            "schema": {
+              "$ref": "#/definitions/CheckNameAvailabilityParameters"
+            },
+            "description": "Parameters supplied to the CheckNameAvailability Redis operation."
+          },
+          {
+            "$ref": "#/parameters/ApiVersionParameter"
+          },
+          {
+            "$ref": "#/parameters/SubscriptionIdParameter"
+          }
+        ],
+        "responses": {
+          "200": {
+            "description": "Name is available"
+          }
+        }
+      }
+    },
+    "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cache/Redis/{name}/listUpgradeNotifications": {
+      "get": {
+        "tags": [
+          "Redis"
+        ],
+        "operationId": "Redis_ListUpgradeNotifications",
+        "x-ms-examples": {
+          "RedisCacheGet": { "$ref": "./examples/RedisCacheListUpgradeNotifications.json" }
+        },
+        "description": "Gets any upgrade notifications for a Redis cache.",
+        "parameters": [
+          {
+            "name": "resourceGroupName",
+            "in": "path",
+            "required": true,
+            "type": "string",
+            "description": "The name of the resource group."
+          },
+          {
+            "name": "name",
+            "in": "path",
+            "required": true,
+            "type": "string",
+            "description": "The name of the Redis cache."
+          },
+          {
+            "$ref": "#/parameters/ApiVersionParameter"
+          },
+          {
+            "$ref": "#/parameters/SubscriptionIdParameter"
+          },
+          {
+            "name": "history",
+            "in": "query",
+            "required": true,
+            "type": "number",
+            "format": "double",
+            "description": "how many minutes in past to look for upgrade notifications"
+          }
+        ],
+        "responses": {
+          "200": {
+            "description": "All upgrade notifications in given time range",
+            "schema": {
+              "$ref": "#/definitions/NotificationListResponse"
+            }
+          }
+        }
+      }
+    },
     "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cache/Redis/{name}": {
       "put": {
         "tags": [
@@ -247,7 +331,7 @@
         }
       }
     },
-    "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cache/Redis/": {
+    "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cache/Redis": {
       "get": {
         "tags": [
           "Redis"
@@ -285,7 +369,7 @@
         }
       }
     },
-    "/subscriptions/{subscriptionId}/providers/Microsoft.Cache/Redis/": {
+    "/subscriptions/{subscriptionId}/providers/Microsoft.Cache/Redis": {
       "get": {
         "tags": [
           "Redis"
@@ -777,7 +861,7 @@
         }
       }
     },
-    "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cache/Redis/{name}/patchSchedules/default": {
+    "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cache/Redis/{name}/patchSchedules/{default}": {
       "put": {
         "tags": [
           "Redis"
@@ -802,6 +886,20 @@
             "type": "string",
             "description": "The name of the Redis cache."
           },
+          {
+            "name": "default",
+            "in": "path",
+            "required": true,
+            "type": "string",
+            "description": "Default string modeled as parameter for auto generation to work correctly.",
+            "enum": [
+              "default"
+            ],
+            "x-ms-enum": {
+              "name": "defaultName",
+              "modelAsString": true
+            }
+          },
           {
             "name": "parameters",
             "in": "body",
@@ -857,6 +955,20 @@
             "type": "string",
             "description": "The name of the redis cache."
           },
+          {
+            "name": "default",
+            "in": "path",
+            "required": true,
+            "type": "string",
+            "description": "Default string modeled as parameter for auto generation to work correctly.",
+            "enum": [
+              "default"
+            ],
+            "x-ms-enum": {
+              "name": "defaultName",
+              "modelAsString": true
+            }
+          },
           {
             "$ref": "#/parameters/ApiVersionParameter"
           },
@@ -897,6 +1009,20 @@
             "type": "string",
             "description": "The name of the redis cache."
           },
+          {
+            "name": "default",
+            "in": "path",
+            "required": true,
+            "type": "string",
+            "description": "Default string modeled as parameter for auto generation to work correctly.",
+            "enum": [
+              "default"
+            ],
+            "x-ms-enum": {
+              "name": "defaultName",
+              "modelAsString": true
+            }
+          },
           {
             "$ref": "#/parameters/ApiVersionParameter"
           },
@@ -1832,6 +1958,60 @@
           "description": "URL to get the next set of operation list results if there are any."
         }
       }
+    },
+    "CheckNameAvailabilityParameters": {
+      "description": "Parameters body to pass for  name availability check.",
+      "properties": {
+        "name": {
+          "type": "string",
+          "description": "Resource name."
+        },
+        "type": {
+          "type": "string",
+          "description": "Resource type."
+        }
+      }
+    },
+    "UpgradeNotification": {
+      "properties": {
+        "name": {
+          "readOnly": true,
+          "type": "string",
+          "description": "Name of upgrade notification."
+        },
+        "timestamp": {
+          "readOnly": true,
+          "type": "string",
+          "format": "date-time",
+          "description": "Timestamp when upgrade notification occured."
+        },
+        "upsellNotification": {
+          "readOnly": true,
+          "type": "object",
+          "additionalProperties": {
+            "type": "string"
+          },
+          "description": "Details about this upgrade notification"
+        }
+      },
+      "description": "Properties of upgrade notification."
+    },
+    "NotificationListResponse": {
+      "properties": {
+        "value": {
+          "type": "array",
+          "items": {
+            "$ref": "#/definitions/UpgradeNotification"
+          },
+          "description": "List of all notifications."
+        },
+        "nextLink": {
+          "type": "string",
+          "readOnly": true,
+          "description": "Link for next set of notifications."
+        }
+      },
+      "description": "The response of listUpgradeNotifications."
     }
   },
   "parameters": {