Added cost analysis documentation (#7406)

ChilliCream · Aug 27, 2024 · 8379ce2 · 8379ce2
1 parent 91fc947
commit 8379ce2
Show file tree

Hide file tree

Showing 7 changed files with 507 additions and 221 deletions.
diff --git a/.markdownlint.yml b/.markdownlint.yml
@@ -18,9 +18,12 @@ MD033:
     - ExampleTabs
     - img
     - InputChoiceTabs
+    - List
     - PackageInstallation
+    - Panel
     - Schema
     - strong
+    - Tab
     - u
     - Video
 MD036: false # Rationale: Possibly too strict, used frequently in documentation.
diff --git a/website/src/docs/docs.json b/website/src/docs/docs.json
@@ -392,8 +392,8 @@
                 "title": "Authorization"
               },
               {
-                "path": "operation-complexity",
-                "title": "Operation Complexity"
+                "path": "cost-analysis",
+                "title": "Cost Analysis"
               }
             ]
           },

diff --git a/website/src/docs/hotchocolate/v14/migrating/migrate-from-13-to-14.md b/website/src/docs/hotchocolate/v14/migrating/migrate-from-13-to-14.md
@@ -76,6 +76,15 @@ The interface `IQueryResultBuilder` and its implementations were replaced with `
 
 The interface `IQueryResultBuilder` and its implementations were replaced with `OperationResultBuilder` which produces an `OperationResult` on `Build()`.
 
+## Operation complexity analyzer replaced
+
+The Operation Complexity Analyzer in v13 has been replaced by Cost Analysis in v14, based on the draft [IBM Cost Analysis specification](https://ibm.github.io/graphql-specs/cost-spec.html).
+
+- The `Complexity` property on `RequestExecutorOptions` (accessed via `ModifyRequestOptions`) has been removed.
+- Cost analysis is enabled by default.
+
+Please see the [documentation](../../security/cost-analysis) for further information.
+
 ## DateTime scalar enforces a specific format
 
 The `DateTime` scalar will now enforce a specific format. The time and offset are now required, and fractional seconds are limited to 7. This aligns it with the DateTime Scalar spec (<https://www.graphql-scalars.com/date-time/>), with the one difference being that fractions of a second are optional, and 0-7 digits may be specified.