From 38c1c113ca93dcfe0c24b6425a06d8debc2cac9c Mon Sep 17 00:00:00 2001
From: Sasha <64744993+r1tsuu@users.noreply.github.com>
Date: Wed, 19 Feb 2025 03:59:05 +0200
Subject: [PATCH] docs: remove outdated `res` parameter in `login` and
 `resetPassword` operations (#11268)

Fixes https://github.com/payloadcms/payload/issues/9829

As described in the issue, the `res` parameter does no more exist for
these operations. Additionally, marks `req` as an optional property.
---
 docs/local-api/overview.mdx | 8 +++-----
 1 file changed, 3 insertions(+), 5 deletions(-)

diff --git a/docs/local-api/overview.mdx b/docs/local-api/overview.mdx
index 4bba92774..fd4601e2e 100644
--- a/docs/local-api/overview.mdx
+++ b/docs/local-api/overview.mdx
@@ -345,8 +345,7 @@ const result = await payload.login({
     email: 'dev@payloadcms.com',
     password: 'rip',
   },
-  req: req, // pass a Request object to be provided to all hooks
-  res: res, // used to automatically set an HTTP-only auth cookie
+  req: req, // optional, pass a Request object to be provided to all hooks
   depth: 2,
   locale: 'en',
   fallbackLocale: false,
@@ -384,8 +383,7 @@ const result = await payload.resetPassword({
     password: req.body.password, // the new password to set
     token: 'afh3o2jf2p3f...', // the token generated from the forgotPassword operation
   },
-  req: req, // pass a Request object to be provided to all hooks
-  res: res, // used to automatically set an HTTP-only auth cookie
+  req: req, // optional, pass a Request object to be provided to all hooks
 })
 ```
 
@@ -399,7 +397,7 @@ const result = await payload.unlock({
     // required
     email: 'dev@payloadcms.com',
   },
-  req: req, // pass a Request object to be provided to all hooks
+  req: req, // optional, pass a Request object to be provided to all hooks
   overrideAccess: true,
 })
 ```