Browse Source

feat: Generate swagger json for relation and formula

Signed-off-by: Pranav C <61551451+pranavxc@users.noreply.github.com>
pull/448/head
Pranav C 3 years ago committed by Pranav C
parent
commit
20f7d45e04
  1. 4
      packages/nocodb/src/lib/noco/common/BaseApiBuilder.ts
  2. 6
      packages/nocodb/src/lib/noco/gql/GqlApiBuilder.ts
  3. 52
      packages/nocodb/src/lib/noco/rest/RestApiBuilder.ts
  4. 29
      packages/nocodb/src/lib/sqlMgr/code/routers/xc-ts/SwaggerXc.ts

4
packages/nocodb/src/lib/noco/common/BaseApiBuilder.ts

@ -1365,7 +1365,7 @@ export default abstract class BaseApiBuilder<T extends Noco> implements XcDynami
} }
protected async getManyToManyRelations({parent = null, child = null, localMetas = null} = {}) { protected async getManyToManyRelations({parent = null, child = null, localMetas = null} = {}): Promise<Set<any>> {
const metas = new Set<any>(); const metas = new Set<any>();
const assocMetas = new Set<any>(); const assocMetas = new Set<any>();
@ -1492,6 +1492,8 @@ export default abstract class BaseApiBuilder<T extends Noco> implements XcDynami
this.models[meta.tn] = this.getBaseModel(meta) this.models[meta.tn] = this.getBaseModel(meta)
} }
} }
return metas;
} }

6
packages/nocodb/src/lib/noco/gql/GqlApiBuilder.ts

@ -1852,8 +1852,8 @@ export class GqlApiBuilder extends BaseApiBuilder<Noco> implements XcMetaMgr {
log(`${this.dbAlias} : ${str}`, ...args); log(`${this.dbAlias} : ${str}`, ...args);
} }
public async onManyToManyRelationCreate(parent: string, child: string, args?: any) { public async onManyToManyRelationCreate(parent: string, child: string, args?: any): Promise<Set<any>> {
await super.onManyToManyRelationCreate(parent, child, args); const res = await super.onManyToManyRelationCreate(parent, child, args);
for (const tn of [parent, child]) { for (const tn of [parent, child]) {
const meta = this.metas[tn]; const meta = this.metas[tn];
const {columns, hasMany, belongsTo, manyToMany} = meta; const {columns, hasMany, belongsTo, manyToMany} = meta;
@ -1900,7 +1900,7 @@ export class GqlApiBuilder extends BaseApiBuilder<Noco> implements XcMetaMgr {
}); });
await this.reInitializeGraphqlEndpoint(); await this.reInitializeGraphqlEndpoint();
return res;
} }
public async onManyToManyRelationDelete(parent: string, child: string, args?: any) { public async onManyToManyRelationDelete(parent: string, child: string, args?: any) {

52
packages/nocodb/src/lib/noco/rest/RestApiBuilder.ts

@ -291,7 +291,7 @@ export class RestApiBuilder extends BaseApiBuilder<Noco> {
r._rtn = args?.tableNames?.find(t => t.tn === r.rtn)?._tn || this.getTableNameAlias(r.rtn); r._rtn = args?.tableNames?.find(t => t.tn === r.rtn)?._tn || this.getTableNameAlias(r.rtn);
r._tn = args?.tableNames?.find(t => t.tn === r.tn)?._tn || this.getTableNameAlias(r.tn); r._tn = args?.tableNames?.find(t => t.tn === r.tn)?._tn || this.getTableNameAlias(r.tn);
r.enabled = true; r.enabled = true;
}) });
this.relationsCount = relations.length; this.relationsCount = relations.length;
@ -564,7 +564,6 @@ export class RestApiBuilder extends BaseApiBuilder<Noco> {
await NcHelp.executeOperations(relationRoutes, this.connectionConfig.client); await NcHelp.executeOperations(relationRoutes, this.connectionConfig.client);
await this.getManyToManyRelations();
const swaggerDoc = { const swaggerDoc = {
@ -600,6 +599,8 @@ export class RestApiBuilder extends BaseApiBuilder<Noco> {
} }
await this.getManyToManyRelations();
} }
@ -1152,7 +1153,6 @@ export class RestApiBuilder extends BaseApiBuilder<Noco> {
swaggerArr.push(new SwaggerXc({ctx: {...ctx, v: oldMeta.v}}).getObject()); swaggerArr.push(new SwaggerXc({ctx: {...ctx, v: oldMeta.v}}).getObject());
if (queryParams?.showFields) { if (queryParams?.showFields) {
queryParams.showFields[`${this.getTableNameAlias(tnp)} <= ${this.getTableNameAlias(tnc)}`] = true; queryParams.showFields[`${this.getTableNameAlias(tnp)} <= ${this.getTableNameAlias(tnc)}`] = true;
} }
@ -1798,6 +1798,52 @@ export class RestApiBuilder extends BaseApiBuilder<Noco> {
await this.onSwaggerDocUpdate(tn); await this.onSwaggerDocUpdate(tn);
} }
protected async getManyToManyRelations(args = {}): Promise<Set<any>> {
const metas:Set<any> = await super.getManyToManyRelations(args);
for (const metaObj of metas) {
const ctx = this.generateContextForTable(
metaObj.tn,
metaObj.columns,
[...metaObj.belongsTo, ...metaObj.hasMany],
metaObj.hasMany,
metaObj.belongsTo
);
const swaggerDoc = await new SwaggerXc({
dir: '', ctx: {
...ctx,
v: metaObj.v
}, filename: ''
}).getObject();
const meta = await this.xcMeta.metaGet(this.projectId, this.dbAlias, 'nc_models', {
title: metaObj.tn,
type: 'table'
});
const oldSwaggerDoc = JSON.parse(meta.schema);
// keep upto 5 schema backup on table update
let previousSchemas = [oldSwaggerDoc]
if (meta.schema_previous) {
previousSchemas = [...JSON.parse(meta.schema_previous), oldSwaggerDoc].slice(-5);
}
oldSwaggerDoc.definitions = swaggerDoc.definitions;
await this.xcMeta.metaUpdate(this.projectId, this.dbAlias, 'nc_models', {
schema: JSON.stringify(oldSwaggerDoc),
schema_previous: JSON.stringify(previousSchemas)
}, {
title: metaObj.tn,
type: 'table'
});
}
return metas
}
} }

29
packages/nocodb/src/lib/sqlMgr/code/routers/xc-ts/SwaggerXc.ts

@ -63,11 +63,14 @@ class SwaggerXc extends BaseRender {
[args._tn]: { [args._tn]: {
type: 'object', type: 'object',
properties: {} properties: {}
},
[`${args._tn}Nested`]: {
type: 'object',
properties: {}
} }
}; };
const properties = obj[args._tn].properties; let properties = obj[args._tn].properties;
for (const column of args.columns) { for (const column of args.columns) {
const field: any = {}; const field: any = {};
@ -85,6 +88,7 @@ class SwaggerXc extends BaseRender {
properties[column._cn] = field; properties[column._cn] = field;
} }
properties = Object.assign(obj[`${args._tn}Nested`].properties, properties)
for (const column of (args.v || [])) { for (const column of (args.v || [])) {
const field: any = {}; const field: any = {};
field.readOnly = true; field.readOnly = true;
@ -99,13 +103,13 @@ class SwaggerXc extends BaseRender {
} else if (column.hm) { } else if (column.hm) {
field.type = 'array'; field.type = 'array';
field.items = { field.items = {
$ref: `#/definitions/${column.mm?._rtn}` $ref: `#/definitions/${column.hm?._tn}`
}; };
field.$ref = `#/definitions/${column.mm?._rtn}` field.$ref = `#/definitions/${column.hm?._tn}`
_cn = `${column.mm?._rtn}List`; _cn = `${column.hm?._tn}List`;
} else if (column.bt) { } else if (column.bt) {
field.$ref = `#/definitions/${column.mm?._tn}` field.$ref = `#/definitions/${column.bt?._rtn}`
_cn = `${column.mm?._rtn}Read`; _cn = `${column.bt?._rtn}Read`;
} }
properties[_cn] = field; properties[_cn] = field;
@ -227,8 +231,17 @@ class SwaggerXc extends BaseRender {
"responses": { "responses": {
"405": { "405": {
"description": "Invalid input" "description": "Invalid input"
},
"200": {
"description": "successful operation",
"schema": {
type: "array",
items: {
"$ref": `#/definitions/${this.ctx._tn}Nested`
} }
} }
},
}
} }
}, },
[`/nc/${this.ctx.project_id}/api/${this.ctx.routeVersionLetter}/${this.ctx._tn}/{${this.ctx._tn}Id}`]: { [`/nc/${this.ctx.project_id}/api/${this.ctx.routeVersionLetter}/${this.ctx._tn}/{${this.ctx._tn}Id}`]: {
@ -273,7 +286,7 @@ class SwaggerXc extends BaseRender {
"200": { "200": {
"description": "successful operation", "description": "successful operation",
"schema": { "schema": {
"$ref": `#/definitions/${this.ctx._tn}` "$ref": `#/definitions/${this.ctx._tn}Nested`
} }
}, },
"400": { "400": {

Loading…
Cancel
Save