policy: replace enums with oneOfs in the schemas

The reason is that this way, we can add a description for each of the options.
3scale · Jan 26, 2018 · e7d780d · e7d780d
1 parent 91bcf26
commit e7d780d
Show file tree

Hide file tree

Showing 4 changed files with 53 additions and 9 deletions.
diff --git a/gateway/src/apicast/policy/caching/apicast-policy.json b/gateway/src/apicast/policy/caching/apicast-policy.json
@@ -23,8 +23,24 @@
     "properties": {
       "caching_type": {
         "description": "Caching mode",
-        "type": "string",
-        "enum": ["resilient", "strict", "allow", "none"]
+        "oneOf": [
+          {
+            "const": "resilient",
+            "description": "Authorize according to last request when backend is down."
+          },
+          {
+            "const": "strict",
+            "description": "It only caches authorized calls."
+          },
+          {
+            "const": "allow",
+            "description": "When backend is down, allow everything unless seen before and denied."
+          },
+          {
+            "const": "none",
+            "description": "Disables caching."
+          }
+        ]
       }
     }
   }

diff --git a/gateway/src/apicast/policy/echo/apicast-policy.json b/gateway/src/apicast/policy/echo/apicast-policy.json
@@ -13,9 +13,17 @@
         "type": "integer"
       },
       "exit": {
-        "description": "Exit mode. 'request' interrupts the processing of the request, 'phase' only skips the rewrite phase.",
-        "type": "string",
-        "enum": ["request", "phase"]
+        "description": "Exit mode",
+        "oneOf": [
+          {
+            "const": "request",
+            "description": "Interrupts the processing of the request."
+          },
+          {
+            "const": "set",
+            "description": "Only skips the rewrite phase."
+          }
+        ]
       }
     }
   }

diff --git a/gateway/src/apicast/policy/headers/apicast-policy.json b/gateway/src/apicast/policy/headers/apicast-policy.json
@@ -18,8 +18,20 @@
           "properties": {
             "op": {
               "description": "Operation to be applied",
-              "type": "string",
-              "enum": ["add", "set", "push"]
+              "oneOf": [
+                {
+                  "const": "add",
+                  "description": "Adds a value to an existing header."
+                },
+                {
+                  "const": "set",
+                  "description": "Creates the header when not set, replaces its value when set."
+                },
+                {
+                  "const": "push",
+                  "description": "Creates the header when not set, adds the value when set."
+                }
+              ]
             },
             "header": {
               "description": "Header to be modified",

diff --git a/gateway/src/apicast/policy/url_rewriting/apicast-policy.json b/gateway/src/apicast/policy/url_rewriting/apicast-policy.json
@@ -19,8 +19,16 @@
           "properties": {
             "op": {
               "description": "Operation to be applied (sub or gsub)",
-              "type": "string",
-              "enum": ["sub", "gsub"]
+              "oneOf": [
+                {
+                  "const": "sub",
+                  "description": "Substitutes the first match of the regex applied."
+                },
+                {
+                  "const": "gsub",
+                  "description": "Substitutes all the matches of the regex applied."
+                }
+              ]
             },
             "regex": {
               "description": "Regular expression to be matched",