Add swagger for Spring Cloud Gateway response cache (#25924)

Azure · Oct 11, 2023 · b5d9b53 · b5d9b53
1 parent fd3b751
commit b5d9b53
Show file tree

Hide file tree

Showing 4 changed files with 94 additions and 0 deletions.
diff --git a/...atform/resource-manager/Microsoft.AppPlatform/preview/2023-11-01-preview/appplatform.json b/...atform/resource-manager/Microsoft.AppPlatform/preview/2023-11-01-preview/appplatform.json
@@ -13923,6 +13923,11 @@
         "operatorProperties": {
           "$ref": "#/definitions/GatewayOperatorProperties",
           "readOnly": true
+        },
+        "responseCacheProperties": {
+          "$ref": "#/definitions/GatewayResponseCacheProperties",
+          "description": "The properties to configure different types of response cache for Spring Cloud Gateway.",
+          "x-ms-client-flatten": false
         }
       }
     },
@@ -14321,6 +14326,70 @@
         }
       }
     },
+    "GatewayResponseCacheProperties": {
+      "description": "Spring Cloud Gateway response cache properties.",
+      "required": [
+        "responseCacheType"
+      ],
+      "type": "object",
+      "properties": {
+        "responseCacheType": {
+          "description": "The type of the response cache.",
+          "type": "string",
+          "x-ms-mutability": [
+            "create",
+            "read"
+          ]
+        }
+      },
+      "discriminator": "responseCacheType"
+    },
+    "GatewayLocalResponseCachePerRouteProperties": {
+      "description": "Spring Cloud Gateway local response cache per route properties.",
+      "required": [
+        "responseCacheType"
+      ],
+      "type": "object",
+      "allOf": [
+        {
+          "$ref": "#/definitions/GatewayResponseCacheProperties"
+        }
+      ],
+      "properties": {
+        "size": {
+          "description": "Maximum size of cache (10MB, 900KB, 1GB...) to determine if the cache needs to evict some entries.",
+          "type": "string"
+        },
+        "timeToLive": {
+          "description": "Time before a cached entry is expired (300s, 5m, 1h...)",
+          "type": "string"
+        }
+      },
+      "x-ms-discriminator-value": "LocalCachePerRoute"
+    },
+    "GatewayLocalResponseCachePerInstanceProperties": {
+      "description": "Spring Cloud Gateway local response cache per instance properties.",
+      "required": [
+        "responseCacheType"
+      ],
+      "type": "object",
+      "allOf": [
+        {
+          "$ref": "#/definitions/GatewayResponseCacheProperties"
+        }
+      ],
+      "properties": {
+        "size": {
+          "description": "Maximum size of cache (10MB, 900KB, 1GB...) to determine if the cache needs to evict some entries",
+          "type": "string"
+        },
+        "timeToLive": {
+          "description": "Time before a cached entry is expired (300s, 5m, 1h...)",
+          "type": "string"
+        }
+      },
+      "x-ms-discriminator-value": "LocalCachePerInstance"
+    },
     "ApiPortalResourceCollection": {
       "description": "Object that includes an array of API portal resources and a possible link for next set",
       "type": "object",

diff --git a/...er/Microsoft.AppPlatform/preview/2023-11-01-preview/examples/Gateways_CreateOrUpdate.json b/...er/Microsoft.AppPlatform/preview/2023-11-01-preview/examples/Gateways_CreateOrUpdate.json
@@ -16,6 +16,11 @@
         "resourceRequests": {
           "cpu": "1",
           "memory": "1G"
+        },
+        "responseCacheProperties": {
+          "responseCacheType": "LocalCachePerRoute",
+          "size": "5MB",
+          "timeToLive": "300s"
         }
       },
       "sku": {
@@ -41,6 +46,11 @@
             "cpu": "1",
             "memory": "1G"
           },
+          "responseCacheProperties": {
+            "responseCacheType": "LocalCachePerRoute",
+            "size": "5MB",
+            "timeToLive": "300s"
+          },
           "instances": [
             {
               "name": "instance1",
@@ -102,6 +112,11 @@
             "cpu": "1",
             "memory": "1G"
           },
+          "responseCacheProperties": {
+            "responseCacheType": "LocalCachePerRoute",
+            "size": "5MB",
+            "timeToLive": "300s"
+          },
           "instances": [
             {
               "name": "instance1",

diff --git a/...ource-manager/Microsoft.AppPlatform/preview/2023-11-01-preview/examples/Gateways_Get.json b/...ource-manager/Microsoft.AppPlatform/preview/2023-11-01-preview/examples/Gateways_Get.json
@@ -17,6 +17,11 @@
             "cpu": "1",
             "memory": "1G"
           },
+          "responseCacheProperties": {
+            "responseCacheType": "LocalCachePerRoute",
+            "size": "5MB",
+            "timeToLive": "300s"
+          },
           "instances": [
             {
               "name": "instance1",

diff --git a/...urce-manager/Microsoft.AppPlatform/preview/2023-11-01-preview/examples/Gateways_List.json b/...urce-manager/Microsoft.AppPlatform/preview/2023-11-01-preview/examples/Gateways_List.json
@@ -18,6 +18,11 @@
                 "cpu": "1",
                 "memory": "1G"
               },
+              "responseCacheProperties": {
+                "responseCacheType": "LocalCachePerRoute",
+                "size": "5MB",
+                "timeToLive": "300s"
+              },
               "instances": [
                 {
                   "name": "instance1",