Merge pull request #2462 from nocodb/fix/auth-api-corrections

fix: api path correction

packages/noco-docs/content/en/developer-resources/rest-apis.md

@@ -21,15 +21,15 @@ Currently, the default value for {orgs} is <b>noco</b>. Users will be able to ch
 
 | Category | Method | Tag | Function Name | Path |
 |---|---|---|---|---|
-| Auth | Post | auth | signup | /api/v1/db/auth/user/signup |
-| Auth | Post | auth | signin | /api/v1/db/auth/user/signin |
-| Auth | Get | auth | me | /api/v1/db/auth/user/me |
-| Auth | Post | auth | passwordForgot | /api/v1/db/auth/password/forgot |
-| Auth | Post | auth | passwordChange | /api/v1/db/auth/password/change |
-| Auth | Post | auth | passwordReset | /api/v1/db/auth/password/reset/{token} |
-| Auth | Post | auth | tokenRefresh | /api/v1/db/auth/token/refresh |
-| Auth | Post | auth | passwordResetTokenValidate | /api/v1/db/auth/token/validate/{token} |
-| Auth | Post | auth | emailValidate | /api/v1/db/auth/email/validate/{email} |
+| Auth | Post | auth | signup | /api/v1/auth/user/signup |
+| Auth | Post | auth | signin | /api/v1/auth/user/signin |
+| Auth | Get | auth | me | /api/v1/auth/user/me |
+| Auth | Post | auth | passwordForgot | /api/v1/auth/password/forgot |
+| Auth | Post | auth | passwordChange | /api/v1/auth/password/change |
+| Auth | Post | auth | passwordReset | /api/v1/auth/password/reset/{token} |
+| Auth | Post | auth | tokenRefresh | /api/v1/auth/token/refresh |
+| Auth | Post | auth | passwordResetTokenValidate | /api/v1/auth/token/validate/{token} |
+| Auth | Post | auth | emailValidate | /api/v1/auth/email/validate/{email} |
 
 ### Public APIs
 

packages/nocodb-sdk/src/lib/Api.ts

@@ -805,7 +805,7 @@ export class Api<
      * @tags Auth
      * @name Signup
      * @summary Signup
-     * @request POST:/api/v1/db/auth/user/signup
+     * @request POST:/api/v1/auth/user/signup
      * @response `200` `{ token?: string }` OK
      * @response `400` `{ msg?: string }` Bad Request
      * @response `401` `void` Unauthorized
@@ -816,7 +816,7 @@ export class Api<
       params: RequestParams = {}
     ) =>
       this.request<{ token?: string }, { msg?: string } | void>({
-        path: `/api/v1/db/auth/user/signup`,
+        path: `/api/v1/auth/user/signup`,
         method: 'POST',
         body: data,
         format: 'json',
@@ -829,7 +829,7 @@ export class Api<
      * @tags Auth
      * @name Signin
      * @summary Signin
-     * @request POST:/api/v1/db/auth/user/signin
+     * @request POST:/api/v1/auth/user/signin
      * @response `200` `{ token?: string }` OK
      * @response `400` `{ msg?: string }` Bad Request
      */
@@ -838,7 +838,7 @@ export class Api<
       params: RequestParams = {}
     ) =>
       this.request<{ token?: string }, { msg?: string }>({
-        path: `/api/v1/db/auth/user/signin`,
+        path: `/api/v1/auth/user/signin`,
         method: 'POST',
         body: data,
         type: ContentType.Json,
@@ -852,12 +852,12 @@ export class Api<
      * @tags Auth
      * @name Me
      * @summary User info
-     * @request GET:/api/v1/db/auth/user/me
+     * @request GET:/api/v1/auth/user/me
      * @response `200` `UserInfoType` OK
      */
     me: (query?: { project_id?: string }, params: RequestParams = {}) =>
       this.request<UserInfoType, any>({
-        path: `/api/v1/db/auth/user/me`,
+        path: `/api/v1/auth/user/me`,
         method: 'GET',
         query: query,
         format: 'json',
@@ -870,13 +870,13 @@ export class Api<
      * @tags Auth
      * @name PasswordForgot
      * @summary Password forgot
-     * @request POST:/api/v1/db/auth/password/forgot
+     * @request POST:/api/v1/auth/password/forgot
      * @response `200` `void` OK
      * @response `401` `void` Unauthorized
      */
     passwordForgot: (data: { email?: string }, params: RequestParams = {}) =>
       this.request<void, void>({
-        path: `/api/v1/db/auth/password/forgot`,
+        path: `/api/v1/auth/password/forgot`,
         method: 'POST',
         body: data,
         type: ContentType.Json,
@@ -889,7 +889,7 @@ export class Api<
      * @tags Auth
      * @name PasswordChange
      * @summary Password change
-     * @request POST:/api/v1/db/auth/password/change
+     * @request POST:/api/v1/auth/password/change
      * @response `200` `{ msg?: string }` OK
      * @response `400` `{ msg?: string }` Bad request
      */
@@ -898,7 +898,7 @@ export class Api<
       params: RequestParams = {}
     ) =>
       this.request<{ msg?: string }, { msg?: string }>({
-        path: `/api/v1/db/auth/password/change`,
+        path: `/api/v1/auth/password/change`,
         method: 'POST',
         body: data,
         type: ContentType.Json,
@@ -912,12 +912,12 @@ export class Api<
      * @tags Auth
      * @name PasswordResetTokenValidate
      * @summary Reset token verify
-     * @request POST:/api/v1/db/auth/token/validate/{token}
+     * @request POST:/api/v1/auth/token/validate/{token}
      * @response `200` `void` OK
      */
     passwordResetTokenValidate: (token: string, params: RequestParams = {}) =>
       this.request<void, any>({
-        path: `/api/v1/db/auth/token/validate/${token}`,
+        path: `/api/v1/auth/token/validate/${token}`,
         method: 'POST',
         ...params,
       }),
@@ -928,12 +928,12 @@ export class Api<
      * @tags Auth
      * @name EmailValidate
      * @summary Verify email
-     * @request POST:/api/v1/db/auth/email/validate/{token}
+     * @request POST:/api/v1/auth/email/validate/{token}
      * @response `200` `void` OK
      */
     emailValidate: (token: string, params: RequestParams = {}) =>
       this.request<void, any>({
-        path: `/api/v1/db/auth/email/validate/${token}`,
+        path: `/api/v1/auth/email/validate/${token}`,
         method: 'POST',
         ...params,
       }),
@@ -944,7 +944,7 @@ export class Api<
      * @tags Auth
      * @name PasswordReset
      * @summary Password reset
-     * @request POST:/api/v1/db/auth/password/reset/{token}
+     * @request POST:/api/v1/auth/password/reset/{token}
      * @response `200` `void` OK
      */
     passwordReset: (
@@ -953,7 +953,7 @@ export class Api<
       params: RequestParams = {}
     ) =>
       this.request<void, any>({
-        path: `/api/v1/db/auth/password/reset/${token}`,
+        path: `/api/v1/auth/password/reset/${token}`,
         method: 'POST',
         body: data,
         type: ContentType.Json,
@@ -966,12 +966,12 @@ export class Api<
      * @tags Auth
      * @name TokenRefresh
      * @summary Refresh token
-     * @request POST:/api/v1/db/auth/token/refresh
+     * @request POST:/api/v1/auth/token/refresh
      * @response `200` `void` OK
      */
     tokenRefresh: (params: RequestParams = {}) =>
       this.request<void, any>({
-        path: `/api/v1/db/auth/token/refresh`,
+        path: `/api/v1/auth/token/refresh`,
         method: 'POST',
         ...params,
       }),

packages/nocodb/src/lib/meta/api/userApi/ui/auth/emailVerify.ts

@@ -54,7 +54,7 @@ export default `<!DOCTYPE html>
     methods: {},
     async created() {
       try {
-        const valid = (await axios.post('<%- baseUrl %>/api/v1/db/auth/email/validate/' + this.token)).data;
+        const valid = (await axios.post('<%- baseUrl %>/api/v1/auth/email/validate/' + this.token)).data;
         this.valid = !!valid;
       } catch (e) {
         this.valid = false;

packages/nocodb/src/lib/meta/api/userApi/userApis.ts

@@ -327,10 +327,10 @@ async function passwordForgot(req: Request<any, any>, res): Promise<any> {
           subject: 'Password Reset Link',
           text: `Visit following link to update your password : ${
             (req as any).ncSiteUrl
-          }/api/v1/db/auth/password/reset/${token}.`,
+          }/api/v1/auth/password/reset/${token}.`,
           html: ejs.render(template, {
             resetLink:
-              (req as any).ncSiteUrl + `/api/v1/db/auth/password/reset/${token}`
+              (req as any).ncSiteUrl + `/api/v1/auth/password/reset/${token}`
           })
         })
       );
@@ -516,7 +516,7 @@ const mapRoutes = router => {
     })(req, res, next)
   );
 
-  // new API
+  // deprecated APIs
   router.post('/api/v1/db/auth/user/signup', catchError(signup));
   router.post('/api/v1/db/auth/user/signin', catchError(signin));
   router.get(
@@ -549,5 +549,39 @@ const mapRoutes = router => {
     '/api/v1/db/auth/password/reset/:tokenId',
     catchError(renderPasswordReset)
   );
+
+  // new API
+  router.post('/api/v1/auth/user/signup', catchError(signup));
+  router.post('/api/v1/auth/user/signin', catchError(signin));
+  router.get(
+    '/api/v1/auth/user/me',
+    extractProjectIdAndAuthenticate,
+    catchError(me)
+  );
+  router.post('/api/v1/auth/password/forgot', catchError(passwordForgot));
+  router.post(
+    '/api/v1/auth/token/validate/:tokenId',
+    catchError(tokenValidate)
+  );
+  router.post(
+    '/api/v1/auth/password/reset/:tokenId',
+    catchError(passwordReset)
+  );
+  router.post(
+    '/api/v1/auth/email/validate/:tokenId',
+    catchError(emailVerification)
+  );
+  router.post(
+    '/api/v1/auth/password/change',
+    ncMetaAclMw(passwordChange, 'passwordChange')
+  );
+  router.post(
+    '/api/v1/auth/token/refresh',
+    ncMetaAclMw(refreshToken, 'refreshToken')
+  );
+  router.get(
+    '/api/v1/auth/password/reset/:tokenId',
+    catchError(renderPasswordReset)
+  );
 };
 export { mapRoutes as userApis };

scripts/sdk/swagger.json

@@ -10,7 +10,7 @@
     }
   ],
   "paths": {
-    "/api/v1/db/auth/user/signup": {
+    "/api/v1/auth/user/signup": {
       "post": {
         "summary": "Signup",
         "operationId": "auth-signup",
@@ -95,7 +95,7 @@
         "description": "Create a new user with provided email and password and first user is marked as super admin. "
       }
     },
-    "/api/v1/db/auth/user/signin": {
+    "/api/v1/auth/user/signin": {
       "post": {
         "summary": "Signin",
         "operationId": "auth-signin",
@@ -167,7 +167,7 @@
       },
       "parameters": []
     },
-    "/api/v1/db/auth/user/me": {
+    "/api/v1/auth/user/me": {
       "parameters": [],
       "get": {
         "summary": "User info",
@@ -214,7 +214,7 @@
         ]
       }
     },
-    "/api/v1/db/auth/password/forgot": {
+    "/api/v1/auth/password/forgot": {
       "post": {
         "summary": "Password forgot",
         "operationId": "auth-password-forgot",
@@ -248,7 +248,7 @@
       },
       "parameters": []
     },
-    "/api/v1/db/auth/password/change": {
+    "/api/v1/auth/password/change": {
       "post": {
         "summary": "Password change",
         "operationId": "auth-password-change",
@@ -336,7 +336,7 @@
       },
       "parameters": []
     },
-    "/api/v1/db/auth/token/validate/{token}": {
+    "/api/v1/auth/token/validate/{token}": {
       "post": {
         "summary": "Reset token verify",
         "operationId": "auth-password-reset-token-validate",
@@ -361,7 +361,7 @@
         }
       ]
     },
-    "/api/v1/db/auth/email/validate/{token}": {
+    "/api/v1/auth/email/validate/{token}": {
       "post": {
         "summary": "Verify email",
         "operationId": "auth-email-validate",
@@ -386,7 +386,7 @@
         }
       ]
     },
-    "/api/v1/db/auth/password/reset/{token}": {
+    "/api/v1/auth/password/reset/{token}": {
       "post": {
         "summary": "Password reset",
         "operationId": "auth-password-reset",
@@ -425,7 +425,7 @@
         }
       ]
     },
-    "/api/v1/db/auth/token/refresh": {
+    "/api/v1/auth/token/refresh": {
       "post": {
         "summary": "Refresh token",
         "operationId": "auth-token-refresh",