docs: demand control preview (#5399)

Co-authored-by: Maria Elisabeth Schreiber <[email protected]> Co-authored-by: Chandrika Srinivasan <[email protected]>
apollographql · Jun 12, 2024 · c71dd36 · c71dd36
1 parent 3d17880
commit c71dd36
Show file tree

Hide file tree

Showing 9 changed files with 618 additions and 0 deletions.
diff --git a/docs/source/config.json b/docs/source/config.json
@@ -82,6 +82,13 @@
           "enterprise"
         ]
       ],
+      "Demand Control" : [
+        "/executing-operations/demand-control",
+        [
+          "enterprise",
+          "preview"
+        ]
+      ],
       "GraphQL Subscriptions": {
         "Subscriptions Setup": [
           "/executing-operations/subscription-support",

diff --git a/docs/source/configuration/overview.mdx b/docs/source/configuration/overview.mdx
@@ -837,6 +837,10 @@ In versions of the Apollo Router prior to 1.17, this limit was defined via the c
 
 </Note>
 
+### Demand control
+
+See [Demand Control](../executing-operations/demand-control) to learn how to analyze the cost of operations and to reject requests with operations that exceed customizable cost limits. 
+
 ### Early cancel
 
 Up until [Apollo Router 1.43.1](https://github.com/apollographql/router/releases/tag/v1.43.1), when the client closed the connection without waiting for the response, the entire request was cancelled and did not go through the entire pipeline. Since this causes issues with request monitoring, the Router introduced a new behaviour in 1.43.1. Now, the entire pipeline is executed if the request is detected as cancelled, but subgraph requests are not actually done. The response will be reported with the `499` status code, but not actually sent to the client.

diff --git a/docs/source/errors.mdx b/docs/source/errors.mdx
@@ -71,3 +71,32 @@ The request was not able to complete within a configured amount of time.  See [c
 You can create Rhai scripts that throw custom status codes. See [Terminating client requests](./customizations/rhai-api#terminating-client-requests) to learn more.
 
 </Note>
+
+## Error codes
+
+### Demand control
+
+Errors returned by the router when [demand control](./executing-operations/demand-control) is enabled.
+
+<PropertyList kind="errCodes">
+<Property name="COST_ESTIMATED_TOO_EXPENSIVE">
+
+The estimated cost of the operation was greater than the configured maximum cost.
+
+</Property>
+<Property name="COST_ACTUAL_TOO_EXPENSIVE">
+
+The actual cost of the operation was greater than the configured maximum cost.
+
+</Property>
+<Property name="COST_QUERY_PARSE_FAILURE">
+
+The query could not be parsed.
+
+</Property>
+ <Property name="COST_RESPONSE_TYPING_FAILURE">
+
+The response from a subgraph did not match the GraphQL schema.
+
+</Property>
+</PropertyList>
diff --git a/docs/source/executing-operations/demand-control.mdx b/docs/source/executing-operations/demand-control.mdx
diff --git a/docs/source/images/demand-control-example-cost-result.png b/docs/source/images/demand-control-example-cost-result.png
diff --git a/docs/source/images/demand-control-example-histogram.png b/docs/source/images/demand-control-example-histogram.png
diff --git a/docs/source/images/demand-control-example-list-lengths.svg b/docs/source/images/demand-control-example-list-lengths.svg
diff --git a/docs/source/images/demand-control-example-updated-cost-result.png b/docs/source/images/demand-control-example-updated-cost-result.png
diff --git a/docs/source/images/demand-control-example-updated-costs.png b/docs/source/images/demand-control-example-updated-costs.png