docs(route2): document dynamic request aliasing (#3300)

cypress-io · Nov 4, 2020 · 1f7c36c · 1f7c36c
1 parent b6829e4
commit 1f7c36c
Showing 1 changed file with 15 additions and 0 deletions.
diff --git a/source/api/commands/route2.md b/source/api/commands/route2.md
@@ -205,6 +205,21 @@ cy.wait('@someRoute').its('response.statusCode').should('eq', 500)
 cy.wait('@someRoute').its('response.body').should('include', 'id')
 ```
 
+### Aliasing individual requests
+
+Aliases can be set on a per-request basis by setting the `alias` property of the intercepted request:
+
+```js
+cy.route2('POST', '/graphql', (req) => {
+  if (req.body.includes('mutation')) {
+    req.alias = 'gqlMutation'
+  }
+})
+
+// assert that a matching request has been made
+cy.wait('@gqlMutation')
+```
+
 ## Stubbing a response
 
 ### With a string