Clarify that only json policy configuration is currently supported (n…

…grok#826) After spending too much time debugging my `yaml` config and then learning we don't support it yet for the SKDs, I'm adding a note so no one else repeats this. --------- Co-authored-by: DevMandy <[email protected]>
mustafacco7 · Jul 9, 2024 · d209aba · d209aba
1 parent b2cbdc3
commit d209aba
Show file tree

Hide file tree

Showing 2 changed files with 86 additions and 86 deletions.
diff --git a/examples/javascript-sdk/http-traffic-policy.mdx b/examples/javascript-sdk/http-traffic-policy.mdx
@@ -13,50 +13,50 @@ const fs = require("fs");
 })();
 ```
 
-```yaml title="policy.json"
+:::info
+
+Traffic Policies can be defined in `json` only when using the SDKs.
+Support for `yaml` is coming soon!
+
+:::
+
+```json title="policy.json"
 {
-  "inbound":
-    [
-      {
-        "name": "FooBarParamNotFound",
-        "expressions": ["'bar' in getQueryParam('foo')"],
-        "actions":
-          [
-            {
-              "type": "custom-response",
-              "config":
-                {
-                  "status_code": 404,
-                  "content": "not found",
-                  "headers": { "content-type": "text/plain" },
-                },
-            },
-          ],
-      },
-      {
-        "name": "BazCookieForLargeRequests",
-        "expressions": ["!hasReqCookie('baz')", "req.content_length > 5000"],
-        "actions": [{ "type": "deny" }],
-      },
-    ],
-  "outbound":
-    [
-      {
-        "name": "LogUnsuccessfulRequests",
-        "expressions": ["res.status_code < 200 && res.status_code >= 300"],
-        "actions":
-          [
-            {
-              "type": "log",
-              "config":
-                {
-                  "metadata":
-                    { "hostport": "example.com:443", "success": false },
-                },
-            },
-          ],
-      },
-    ],
+	"inbound": [
+		{
+			"name": "FooBarParamNotFound",
+			"expressions": ["'bar' in getQueryParam('foo')"],
+			"actions": [
+				{
+					"type": "custom-response",
+					"config": {
+						"status_code": 404,
+						"content": "not found",
+						"headers": { "content-type": "text/plain" }
+					}
+				}
+			]
+		},
+		{
+			"name": "BazCookieForLargeRequests",
+			"expressions": ["!hasReqCookie('baz')", "req.content_length > 5000"],
+			"actions": [{ "type": "deny" }]
+		}
+	],
+	"outbound": [
+		{
+			"name": "LogUnsuccessfulRequests",
+			"expressions": ["res.status_code < 200 && res.status_code >= 300"],
+			"actions": [
+				{
+					"type": "log",
+					"config": {
+						"metadata": { "hostport": "example.com:443", "success": false }
+					}
+				}
+			]
+		}
+	]
 }
 ```
 

diff --git a/examples/python-sdk/http-traffic-policy.mdx b/examples/python-sdk/http-traffic-policy.mdx
@@ -4,50 +4,50 @@ with open('/path/to/policy.json') as f:
 		listener = await session.http_endpoint().policy(policy).listen()
 ```
 
-```yaml title="policy.json"
+:::info
+
+Traffic Policies can be defined in `json` only when using the SDKs.
+Support for `yaml` is coming soon!
+
+:::
+
+```json title="policy.json"
 {
-  "inbound":
-    [
-      {
-        "name": "FooBarParamNotFound",
-        "expressions": ["'bar' in getQueryParam('foo')"],
-        "actions":
-          [
-            {
-              "type": "custom-response",
-              "config":
-                {
-                  "status_code": 404,
-                  "content": "not found",
-                  "headers": { "content-type": "text/plain" },
-                },
-            },
-          ],
-      },
-      {
-        "name": "BazCookieForLargeRequests",
-        "expressions": ["!hasReqCookie('baz')", "req.content_length > 5000"],
-        "actions": [{ "type": "deny" }],
-      },
-    ],
-  "outbound":
-    [
-      {
-        "name": "LogUnsuccessfulRequests",
-        "expressions": ["res.status_code < 200 && res.status_code >= 300"],
-        "actions":
-          [
-            {
-              "type": "log",
-              "config":
-                {
-                  "metadata":
-                    { "hostport": "example.com:443", "success": false },
-                },
-            },
-          ],
-      },
-    ],
+	"inbound": [
+		{
+			"name": "FooBarParamNotFound",
+			"expressions": ["'bar' in getQueryParam('foo')"],
+			"actions": [
+				{
+					"type": "custom-response",
+					"config": {
+						"status_code": 404,
+						"content": "not found",
+						"headers": { "content-type": "text/plain" }
+					}
+				}
+			]
+		},
+		{
+			"name": "BazCookieForLargeRequests",
+			"expressions": ["!hasReqCookie('baz')", "req.content_length > 5000"],
+			"actions": [{ "type": "deny" }]
+		}
+	],
+	"outbound": [
+		{
+			"name": "LogUnsuccessfulRequests",
+			"expressions": ["res.status_code < 200 && res.status_code >= 300"],
+			"actions": [
+				{
+					"type": "log",
+					"config": {
+						"metadata": { "hostport": "example.com:443", "success": false }
+					}
+				}
+			]
+		}
+	]
 }
 ```