From a71819b06a0c0d8523212ebf44e57c0f3e2e52cc Mon Sep 17 00:00:00 2001 From: Pranav C Date: Tue, 12 Apr 2022 19:08:18 +0530 Subject: [PATCH] refactor: api path params name update Signed-off-by: Pranav C --- packages/nocodb-sdk/src/lib/Api.ts | 20 +++++++++---------- .../meta/api/dataApis/bulkDataAliasApis.ts | 10 +++++----- .../lib/noco/meta/api/formViewColumnApis.ts | 2 +- .../lib/noco/meta/api/gridViewColumnApis.ts | 4 ++-- scripts/sdk/swagger.json | 12 +++++------ 5 files changed, 24 insertions(+), 24 deletions(-) diff --git a/packages/nocodb-sdk/src/lib/Api.ts b/packages/nocodb-sdk/src/lib/Api.ts index d94d2297f3..eac3945d1a 100644 --- a/packages/nocodb-sdk/src/lib/Api.ts +++ b/packages/nocodb-sdk/src/lib/Api.ts @@ -1695,7 +1695,7 @@ export class Api< * * @tags DB View * @name FormColumnUpdate - * @request PATCH:/api/v1/db/meta/form/columns/{formViewColumnId} + * @request PATCH:/api/v1/db/meta/form-columns/{formViewColumnId} * @response `200` `any` OK */ formColumnUpdate: ( @@ -1704,7 +1704,7 @@ export class Api< params: RequestParams = {} ) => this.request({ - path: `/api/v1/db/meta/form/columns/${formViewColumnId}`, + path: `/api/v1/db/meta/form-columns/${formViewColumnId}`, method: 'PATCH', body: data, type: ContentType.Json, @@ -1717,12 +1717,12 @@ export class Api< * * @tags DB View * @name GridColumnsList - * @request GET:/api/v1/db/meta/grids/{gidId}/grid/columns + * @request GET:/api/v1/db/meta/grids/{gridId}/grid-columns * @response `200` `(GridColumnType)[]` OK */ - gridColumnsList: (gidId: string, params: RequestParams = {}) => + gridColumnsList: (gridId: string, params: RequestParams = {}) => this.request({ - path: `/api/v1/db/meta/grids/${gidId}/grid/columns`, + path: `/api/v1/db/meta/grids/${gridId}/grid-columns`, method: 'GET', format: 'json', ...params, @@ -1733,7 +1733,7 @@ export class Api< * * @tags DB View * @name GridColumnUpdate - * @request PATCH:/api/v1/db/meta/grid/columns/{columnId} + * @request PATCH:/api/v1/db/meta/grid-columns/{columnId} * @response `200` `any` OK */ gridColumnUpdate: ( @@ -1742,7 +1742,7 @@ export class Api< params: RequestParams = {} ) => this.request({ - path: `/api/v1/db/meta/grid/columns/${columnId}`, + path: `/api/v1/db/meta/grid-columns/${columnId}`, method: 'PATCH', body: data, type: ContentType.Json, @@ -2102,12 +2102,12 @@ export class Api< * * @tags DB Table Filter * @name ChildrenRead - * @request GET:/api/v1/db/meta/filters/{filterParentId}/children + * @request GET:/api/v1/db/meta/filters/{filterGroupId}/children * @response `200` `FilterType` OK */ - childrenRead: (filterParentId: string, params: RequestParams = {}) => + childrenRead: (filterGroupId: string, params: RequestParams = {}) => this.request({ - path: `/api/v1/db/meta/filters/${filterParentId}/children`, + path: `/api/v1/db/meta/filters/${filterGroupId}/children`, method: 'GET', format: 'json', ...params, diff --git a/packages/nocodb/src/lib/noco/meta/api/dataApis/bulkDataAliasApis.ts b/packages/nocodb/src/lib/noco/meta/api/dataApis/bulkDataAliasApis.ts index da81a2df3e..18fe0b1434 100644 --- a/packages/nocodb/src/lib/noco/meta/api/dataApis/bulkDataAliasApis.ts +++ b/packages/nocodb/src/lib/noco/meta/api/dataApis/bulkDataAliasApis.ts @@ -91,23 +91,23 @@ async function getViewAndModelFromRequest(req) { const router = Router({ mergeParams: true }); router.post( - '/bulkData/:orgs/:projectName/:tableAlias', + '/api/v1/db/bulkData/:orgs/:projectName/:tableAlias', ncMetaAclMw(bulkDataInsert, 'bulkDataInsert') ); router.patch( - '/bulkData/:orgs/:projectName/:tableAlias', + '/api/v1/db/bulkData/:orgs/:projectName/:tableAlias', ncMetaAclMw(bulkDataUpdate, 'bulkDataUpdate') ); router.patch( - '/bulkData/:orgs/:projectName/:tableAlias/all', + '/api/v1/db/bulkData/:orgs/:projectName/:tableAlias/all', ncMetaAclMw(bulkDataUpdateAll, 'bulkDataUpdateAll') ); router.delete( - '/bulkData/:orgs/:projectName/:tableAlias', + '/api/v1/db/bulkData/:orgs/:projectName/:tableAlias', ncMetaAclMw(bulkDataDelete, 'bulkDataDelete') ); router.delete( - '/bulkData/:orgs/:projectName/:tableAlias/all', + '/api/v1/db/bulkData/:orgs/:projectName/:tableAlias/all', ncMetaAclMw(bulkDataDeleteAll, 'bulkDataDeleteAll') ); diff --git a/packages/nocodb/src/lib/noco/meta/api/formViewColumnApis.ts b/packages/nocodb/src/lib/noco/meta/api/formViewColumnApis.ts index 879ef33f56..85fc44d8a3 100644 --- a/packages/nocodb/src/lib/noco/meta/api/formViewColumnApis.ts +++ b/packages/nocodb/src/lib/noco/meta/api/formViewColumnApis.ts @@ -10,7 +10,7 @@ export async function columnUpdate(req: Request, res: Response) { const router = Router({ mergeParams: true }); router.patch( - '/api/v1/db/meta/form/columns/:formViewColumnId', + '/api/v1/db/meta/form-columns/:formViewColumnId', ncMetaAclMw(columnUpdate, 'columnUpdate') ); export default router; diff --git a/packages/nocodb/src/lib/noco/meta/api/gridViewColumnApis.ts b/packages/nocodb/src/lib/noco/meta/api/gridViewColumnApis.ts index e3463bac58..f845c09b57 100644 --- a/packages/nocodb/src/lib/noco/meta/api/gridViewColumnApis.ts +++ b/packages/nocodb/src/lib/noco/meta/api/gridViewColumnApis.ts @@ -14,11 +14,11 @@ export async function gridColumnUpdate(req: Request, res: Response) { const router = Router({ mergeParams: true }); router.get( - '/api/v1/db/meta/grids/:gridViewId/grid/columns', + '/api/v1/db/meta/grids/:gridViewId/grid-columns', ncMetaAclMw(columnList, 'columnList') ); router.patch( - '/api/v1/db/meta/grid/columns/:gridViewColumnId', + '/api/v1/db/meta/grid-columns/:gridViewColumnId', ncMetaAclMw(gridColumnUpdate, 'gridColumnUpdate') ); export default router; diff --git a/scripts/sdk/swagger.json b/scripts/sdk/swagger.json index ccb1286edd..690c7ab1a3 100644 --- a/scripts/sdk/swagger.json +++ b/scripts/sdk/swagger.json @@ -2029,7 +2029,7 @@ ] } }, - "/api/v1/db/meta/form/columns/{formViewColumnId}": { + "/api/v1/db/meta/form-columns/{formViewColumnId}": { "parameters": [ { "schema": { @@ -2069,13 +2069,13 @@ } } }, - "/api/v1/db/meta/grids/{gidId}/grid/columns": { + "/api/v1/db/meta/grids/{gridId}/grid-columns": { "parameters": [ { "schema": { "type": "string" }, - "name": "gidId", + "name": "gridId", "in": "path", "required": true } @@ -2103,7 +2103,7 @@ ] } }, - "/api/v1/db/meta/grid/columns/{columnId}": { + "/api/v1/db/meta/grid-columns/{columnId}": { "parameters": [ { "schema": { @@ -4494,7 +4494,7 @@ ] }, - "/bulkData/{orgs}/{projectName}/{tableName}/": { + "/api/v1/db/bulkData/{orgs}/{projectName}/{tableName}/": { "parameters": [ { "schema": { @@ -4597,7 +4597,7 @@ ] } }, - "/bulkData/{orgs}/{projectName}/{tableName}/all": { + "/api/v1/db/bulkData/{orgs}/{projectName}/{tableName}/all": { "parameters": [ { "schema": {