github
/
nocodb
mirror of https://github.com/nocodb/nocodb
1
0
Fork 0
Code Issues Releases Wiki Activity
Browse Source

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

fix: api path correction
pull/2465/head
navi 2 years ago committed by GitHub
parent
b544d3db5c 7b86e88b2d
commit
4ae5e25045
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
5 changed files with 74 additions and 40 deletions
Whitespace
Show all changes Ignore whitespace when comparing lines Ignore changes in amount of whitespace Ignore changes in whitespace at EOL
Unified View
Diff Options
Show Stats Download Patch File Download Diff File
  1. 18
      packages/noco-docs/content/en/developer-resources/rest-apis.md
  2. 36
      packages/nocodb-sdk/src/lib/Api.ts
  3. 2
      packages/nocodb/src/lib/meta/api/userApi/ui/auth/emailVerify.ts
  4. 40
      packages/nocodb/src/lib/meta/api/userApi/userApis.ts
  5. 18
      scripts/sdk/swagger.json

18
packages/noco-docs/content/en/developer-resources/rest-apis.md
Unescape View File

@ -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 | | Category | Method | Tag | Function Name | Path |
|---|---|---|---|---| |---|---|---|---|---|
| Auth | Post | auth | signup | /api/v1/db/auth/user/signup | | Auth | Post | auth | signup | /api/v1/auth/user/signup |
| Auth | Post | auth | signin | /api/v1/db/auth/user/signin | | Auth | Post | auth | signin | /api/v1/auth/user/signin |
| Auth | Get | auth | me | /api/v1/db/auth/user/me | | Auth | Get | auth | me | /api/v1/auth/user/me |
| Auth | Post | auth | passwordForgot | /api/v1/db/auth/password/forgot | | Auth | Post | auth | passwordForgot | /api/v1/auth/password/forgot |
| Auth | Post | auth | passwordChange | /api/v1/db/auth/password/change | | Auth | Post | auth | passwordChange | /api/v1/auth/password/change |
| Auth | Post | auth | passwordReset | /api/v1/db/auth/password/reset/{token} | | Auth | Post | auth | passwordReset | /api/v1/auth/password/reset/{token} |
| Auth | Post | auth | tokenRefresh | /api/v1/db/auth/token/refresh | | Auth | Post | auth | tokenRefresh | /api/v1/auth/token/refresh |
| Auth | Post | auth | passwordResetTokenValidate | /api/v1/db/auth/token/validate/{token} | | Auth | Post | auth | passwordResetTokenValidate | /api/v1/auth/token/validate/{token} |
| Auth | Post | auth | emailValidate | /api/v1/db/auth/email/validate/{email} | | Auth | Post | auth | emailValidate | /api/v1/auth/email/validate/{email} |
### Public APIs ### Public APIs

36
packages/nocodb-sdk/src/lib/Api.ts
Unescape View File

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

2
packages/nocodb/src/lib/meta/api/userApi/ui/auth/emailVerify.ts
Unescape View File

@ -54,7 +54,7 @@ export default `<!DOCTYPE html>
methods: {}, methods: {},
async created() { async created() {
try { 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; this.valid = !!valid;
} catch (e) { } catch (e) {
this.valid = false; this.valid = false;

40
packages/nocodb/src/lib/meta/api/userApi/userApis.ts
Unescape View File

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

18
scripts/sdk/swagger.json
Unescape View File

@ -10,7 +10,7 @@
} }
], ],
"paths": { "paths": {
"/api/v1/db/auth/user/signup": { "/api/v1/auth/user/signup": {
"post": { "post": {
"summary": "Signup", "summary": "Signup",
"operationId": "auth-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. " "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": { "post": {
"summary": "Signin", "summary": "Signin",
"operationId": "auth-signin", "operationId": "auth-signin",
@ -167,7 +167,7 @@
}, },
"parameters": [] "parameters": []
}, },
"/api/v1/db/auth/user/me": { "/api/v1/auth/user/me": {
"parameters": [], "parameters": [],
"get": { "get": {
"summary": "User info", "summary": "User info",
@ -214,7 +214,7 @@
] ]
} }
}, },
"/api/v1/db/auth/password/forgot": { "/api/v1/auth/password/forgot": {
"post": { "post": {
"summary": "Password forgot", "summary": "Password forgot",
"operationId": "auth-password-forgot", "operationId": "auth-password-forgot",
@ -248,7 +248,7 @@
}, },
"parameters": [] "parameters": []
}, },
"/api/v1/db/auth/password/change": { "/api/v1/auth/password/change": {
"post": { "post": {
"summary": "Password change", "summary": "Password change",
"operationId": "auth-password-change", "operationId": "auth-password-change",
@ -336,7 +336,7 @@
}, },
"parameters": [] "parameters": []
}, },
"/api/v1/db/auth/token/validate/{token}": { "/api/v1/auth/token/validate/{token}": {
"post": { "post": {
"summary": "Reset token verify", "summary": "Reset token verify",
"operationId": "auth-password-reset-token-validate", "operationId": "auth-password-reset-token-validate",
@ -361,7 +361,7 @@
} }
] ]
}, },
"/api/v1/db/auth/email/validate/{token}": { "/api/v1/auth/email/validate/{token}": {
"post": { "post": {
"summary": "Verify email", "summary": "Verify email",
"operationId": "auth-email-validate", "operationId": "auth-email-validate",
@ -386,7 +386,7 @@
} }
] ]
}, },
"/api/v1/db/auth/password/reset/{token}": { "/api/v1/auth/password/reset/{token}": {
"post": { "post": {
"summary": "Password reset", "summary": "Password reset",
"operationId": "auth-password-reset", "operationId": "auth-password-reset",
@ -425,7 +425,7 @@
} }
] ]
}, },
"/api/v1/db/auth/token/refresh": { "/api/v1/auth/token/refresh": {
"post": { "post": {
"summary": "Refresh token", "summary": "Refresh token",
"operationId": "auth-token-refresh", "operationId": "auth-token-refresh",

Write Preview
Loading…
Cancel
Save