feat(api): schema definition for new credential checking route

public/openapi/write.yaml

@@ -42,6 +42,8 @@ tags:
 paths:
   /ping:
     $ref: 'write/ping.yaml'
+  /utilities/login:
+    $ref: 'write/login.yaml'
   /users/:
     $ref: 'write/users.yaml'
   /users/{uid}:

public/openapi/write/login.yaml

@@ -0,0 +1,30 @@
+post:
+  tags:
+    - utilities
+  summary: verify login credentials
+  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.
+  requestBody:
+    content:
+      application/json:
+        schema:
+          type: object
+          properties:
+            username:
+              type: string
+              example: admin
+            password:
+              type: string
+              example: '123456'
+  responses:
+    '200':
+      description: credentials successfully validated
+      content:
+        application/json:
+          schema:
+            type: object
+            properties:
+              status:
+                $ref: ../components/schemas/Status.yaml#/Status
+              response:
+                $ref: ../components/schemas/UserObject.yaml#/UserObjectSlim

test/api.js

@@ -332,7 +332,7 @@ describe('API', async () => {
 					}
 				});
 
-				it('should resolve with a 200 when called', async () => {
+				it('should not error out when called', async () => {
 					await setupData();
 
 					if (csrfToken) {
@@ -372,7 +372,7 @@ describe('API', async () => {
 							});
 						}
 					} catch (e) {
-						assert(!e, `${method.toUpperCase()} ${path} resolved with ${e.message}`);
+						assert(!e, `${method.toUpperCase()} ${path} errored with: ${e.message}`);
 					}
 				});