Skip to content

Commit 0ecb66b

Browse files
committed
Update docs
1 parent cd76387 commit 0ecb66b

File tree

1 file changed

+36
-0
lines changed

1 file changed

+36
-0
lines changed

docs/README.md

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,7 @@
44

55
|Name|Type|Description|Required|
66
|----|----|-----------|--------|
7+
|[**aws\_sig\_v4**](#aws_sig_v4)|`object`|Configuration for AWS SigV4 signing of requests to subgraphs.<br/>|yes|
78
|[**cors**](#cors)|`object`|Configuration for CORS (Cross-Origin Resource Sharing).<br/>Default: `{"allow_any_origin":false,"allow_credentials":false,"enabled":false,"policies":[]}`<br/>|yes|
89
|[**csrf**](#csrf)|`object`|Configuration for CSRF prevention.<br/>Default: `{"enabled":false,"required_headers":[]}`<br/>||
910
|[**graphiql**](#graphiql)|`object`|Configuration for the GraphiQL interface.<br/>Default: `{"enabled":true}`<br/>||
@@ -21,6 +22,9 @@
2122
**Example**
2223

2324
```yaml
25+
aws_sig_v4:
26+
enabled: false
27+
subgraphs: {}
2428
cors:
2529
allow_any_origin: false
2630
allow_credentials: false
@@ -113,6 +117,38 @@ traffic_shaping:
113117

114118
```
115119

120+
<a name="aws_sig_v4"></a>
121+
## aws\_sig\_v4: object
122+
123+
Configuration for AWS SigV4 signing of requests to subgraphs.
124+
125+
126+
**Properties**
127+
128+
|Name|Type|Description|Required|
129+
|----|----|-----------|--------|
130+
|**all**|||yes|
131+
|**enabled**|`boolean`|Enables or disables AWS Signature Version 4 signing for requests to subgraphs.<br/>When enabled, the router will sign requests to subgraphs using AWS SigV4.<br/>Default: `false`<br/>|no|
132+
|[**subgraphs**](#aws_sig_v4subgraphs)|`object`|Default: `{}`<br/>|no|
133+
134+
**Additional Properties:** not allowed
135+
**Example**
136+
137+
```yaml
138+
enabled: false
139+
subgraphs: {}
140+
141+
```
142+
143+
<a name="aws_sig_v4subgraphs"></a>
144+
### aws\_sig\_v4\.subgraphs: object
145+
146+
**Additional Properties**
147+
148+
|Name|Type|Description|Required|
149+
|----|----|-----------|--------|
150+
|**Additional Properties**||||
151+
116152
<a name="cors"></a>
117153
## cors: object
118154

0 commit comments

Comments
 (0)