Nemcio/NodeBB
1
0
Fork 0
mirror of https://github.com/NodeBB/NodeBB.git synced 2025-10-26 16:46:12 +01:00
Code Issues Packages Projects Releases Wiki Activity

docs: update verbiage re: login API route

Browse Source
This commit is contained in:
Julian Lam
2021-10-08 15:24:30 -04:00
parent 997fb2b348
commit 94c4f87b2f
1 changed files with 2 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
public/openapi/write/login.yaml
View File

@@ -4,6 +4,8 @@ post:
summary: verify login credentials summary: verify login credentials
description: | description: |
This route accepts a username/password or email/password pair (dependent on forum settings), returning a standard user object if credentials are validated successfully. This route accepts a username/password or email/password pair (dependent on forum settings), returning a standard user object if credentials are validated successfully.
This route also initializes a standard login session and returns a valid cookie that can be used in subsequent API calls as though it were a browser session.
**Note**: Cookie-based sessions require a CSRF token for non-`GET` routes.
requestBody: requestBody:
content: content:
application/json: application/json: