Readme

Author: ardatan

docs/README.md

@@ -15,7 +15,7 @@
 |[**override\_subgraph\_urls**](#override_subgraph_urls)|`object`|Configuration for overriding subgraph URLs.<br/>Default: `{}`<br/>||
 |[**query\_planner**](#query_planner)|`object`|Query planning configuration.<br/>Default: `{"allow_expose":false,"timeout":"10s"}`<br/>||
 |[**supergraph**](#supergraph)|`object`|Configuration for the Federation supergraph source. By default, the router will use a local file-based supergraph source (`./supergraph.graphql`).<br/>||
-|[**traffic\_shaping**](#traffic_shaping)|`object`|Configuration for the traffic-shaper executor. Use these configurations to control how requests are being executed to subgraphs.<br/>Default: `{"dedupe_enabled":true,"max_connections_per_host":100,"pool_idle_timeout_seconds":50}`<br/>||
+|[**traffic\_shaping**](#traffic_shaping)|`object`|Configuration for the traffic-shaping of the executor. Use these configurations to control how requests are being executed to subgraphs.<br/>Default: `{"dedupe_enabled":true,"max_connections_per_host":100,"pool_idle_timeout_seconds":50}`<br/>||
 
 **Additional Properties:** not allowed  
 **Example**
@@ -641,7 +641,7 @@ For more information on the available functions and syntax, see the
 
 |Name|Type|Description|Required|
 |----|----|-----------|--------|
-|**expression**|`string`||yes|
+|**expression**|`string`|The VRL expression string.<br/>|yes|
 
 
 <a name="headersallresponse"></a>
@@ -863,7 +863,7 @@ For more information on the available functions and syntax, see the
 
 |Name|Type|Description|Required|
 |----|----|-----------|--------|
-|**expression**|`string`||yes|
+|**expression**|`string`|The VRL expression string.<br/>|yes|
 
 
 <a name="headerssubgraphs"></a>
@@ -1116,7 +1116,7 @@ For more information on the available functions and syntax, see the
 
 |Name|Type|Description|Required|
 |----|----|-----------|--------|
-|**expression**|`string`||yes|
+|**expression**|`string`|The VRL expression string.<br/>|yes|
 
 
 <a name="headerssubgraphsadditionalpropertiesresponse"></a>
@@ -1338,7 +1338,7 @@ For more information on the available functions and syntax, see the
 
 |Name|Type|Description|Required|
 |----|----|-----------|--------|
-|**expression**|`string`||yes|
+|**expression**|`string`|The VRL expression string.<br/>|yes|
 
 
 <a name="http"></a>
@@ -1808,7 +1808,7 @@ Request timeout for the Hive Console CDN requests.
 <a name="traffic_shaping"></a>
 ## traffic\_shaping: object
 
-Configuration for the traffic-shaper executor. Use these configurations to control how requests are being executed to subgraphs.
+Configuration for the traffic-shaping of the executor. Use these configurations to control how requests are being executed to subgraphs.
 
 
 **Properties**

lib/router-config/src/primitives/expression.rs

@@ -1,6 +1,6 @@
 use once_cell::sync::Lazy;
-use schemars::{JsonSchema, Schema, SchemaGenerator};
-use serde::{Deserialize, Serialize};
+use schemars::{JsonSchema, Schema, SchemaGenerator, json_schema};
+use serde::{Deserialize, Serialize, ser::SerializeStruct};
 use std::{borrow::Cow, collections::BTreeMap};
 use vrl::{
     compiler::{compile as vrl_compile, Program as VrlProgram, TargetValue as VrlTargetValue},
@@ -109,7 +109,9 @@ impl Serialize for Expression {
     where
         S: serde::Serializer,
     {
-        serializer.serialize_str(&self.expression)
+        let mut state = serializer.serialize_struct("Expression", 1)?;
+        state.serialize_field("expression", &self.expression)?;
+        state.end()
     }
 }
 
@@ -118,8 +120,19 @@ impl JsonSchema for Expression {
         "Expression".into()
     }
 
-    fn json_schema(gen: &mut SchemaGenerator) -> Schema {
-        String::json_schema(gen)
+    fn json_schema(_gen: &mut SchemaGenerator) -> Schema {
+        json_schema!({
+            "type": "object",
+            "description": "A VRL expression used for dynamic evaluations.",
+            "properties": {
+                "expression": {
+                    "type": "string",
+                    "description": "The VRL expression string."
+                }
+            },
+            "required": ["expression"],
+            "additionalProperties": false
+        })
     }
 }