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

chore: update swagger and test 

Signed-off-by: Pranav C <pranavxc@gmail.com>
pull/3962/head
Pranav C 2 years ago
parent
d4dcdccb27
commit
4b0c844ce7
3 changed files with 208 additions and 3 deletions
Whitespace
Show all changes Ignore whitespace when comparing lines Ignore changes in amount of whitespace Ignore changes in whitespace at EOL
Split View
Diff Options
Show Stats Download Patch File Download Diff File
  1. 33
      packages/nocodb-sdk/src/lib/Api.ts
  2. 2
      packages/nocodb/tests/unit/rest/tests/project.test.ts
  3. 176
      scripts/sdk/swagger.json

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

@ -3307,10 +3307,39 @@ export class Api<
* @tags Utils
* @name AggregatedMetaInfo
* @request GET:/api/v1/aggregated-meta-info
* @response `200` `any` OK
* @response `200` `{ projectCount?: number, projects?: ({ tableCount?: { table?: number, view?: number }, external?: boolean, viewCount?: { formCount?: number, gridCount?: number, galleryCount?: number, kanbanCount?: number, total?: number, sharedFormCount?: number, sharedGridCount?: number, sharedGalleryCount?: number, sharedKanbanCount?: number, sharedTotal?: number, sharedLockedCount?: number }, webhookCount?: number, filterCount?: number, sortCount?: number, rowCount?: ({ TotalRecords?: string })[], userCount?: number })[], userCount?: number, sharedBaseCount?: number }` OK
*/
aggregatedMetaInfo: (params: RequestParams = {}) =>
this.request<any, any>({
this.request<
{
projectCount?: number;
projects?: {
tableCount?: { table?: number; view?: number };
external?: boolean;
viewCount?: {
formCount?: number;
gridCount?: number;
galleryCount?: number;
kanbanCount?: number;
total?: number;
sharedFormCount?: number;
sharedGridCount?: number;
sharedGalleryCount?: number;
sharedKanbanCount?: number;
sharedTotal?: number;
sharedLockedCount?: number;
};
webhookCount?: number;
filterCount?: number;
sortCount?: number;
rowCount?: { TotalRecords?: string }[];
userCount?: number;
}[];
userCount?: number;
sharedBaseCount?: number;
},
any
>({
path: `/api/v1/aggregated-meta-info`,
method: 'GET',
format: 'json',

2
packages/nocodb/tests/unit/rest/tests/project.test.ts
Unescape View File

@ -301,6 +301,7 @@ function projectTest() {
'sharedTotal',
'sharedLockedCount')
expect(res.body.projects[0]).have.keys(
'external',
'webhookCount',
'filterCount',
'sortCount',
@ -310,6 +311,7 @@ function projectTest() {
'viewCount',
)
expect(res.body).to.have.nested.property('projects[0].rowCount').to.be.an('array')
expect(res.body).to.have.nested.property('projects[0].external').to.be.an('boolean')
})
})
}

176
scripts/sdk/swagger.json
Unescape View File

@ -5347,7 +5347,181 @@
"description": "OK",
"content": {
"application/json": {
"schema": {}
"schema": {
"type": "object",
"properties": {
"projectCount": {
"type": "integer"
},
"projects": {
"type": "array",
"items": {
"type": "object",
"properties": {
"tableCount": {
"type": "object",
"properties": {
"table": {
"type": "integer"
},
"view": {
"type": "integer"
}
}
},
"external": {
"type": "boolean"
},
"viewCount": {
"type": "object",
"properties": {
"formCount": {
"type": "integer"
},
"gridCount": {
"type": "integer"
},
"galleryCount": {
"type": "integer"
},
"kanbanCount": {
"type": "integer"
},
"total": {
"type": "integer"
},
"sharedFormCount": {
"type": "integer"
},
"sharedGridCount": {
"type": "integer"
},
"sharedGalleryCount": {
"type": "integer"
},
"sharedKanbanCount": {
"type": "integer"
},
"sharedTotal": {
"type": "integer"
},
"sharedLockedCount": {
"type": "integer"
}
}
},
"webhookCount": {
"type": "integer"
},
"filterCount": {
"type": "integer"
},
"sortCount": {
"type": "integer"
},
"rowCount": {
"type": "array",
"items": {
"type": "object",
"properties": {
"TotalRecords": {
"type": "string"
}
}
}
},
"userCount": {
"type": "integer"
}
}
}
},
"userCount": {
"type": "integer"
},
"sharedBaseCount": {
"type": "integer"
}
},
"x-examples": {
"Example 1": {
"projectCount": 1,
"projects": [
{
"tableCount": {
"table": 3,
"view": 0
},
"external": false,
"viewCount": {
"formCount": 0,
"gridCount": 3,
"galleryCount": 0,
"kanbanCount": 0,
"total": 3,
"sharedFormCount": 0,
"sharedGridCount": 0,
"sharedGalleryCount": 0,
"sharedKanbanCount": 0,
"sharedTotal": 0,
"sharedLockedCount": 0
},
"webhookCount": 0,
"filterCount": 0,
"sortCount": 0,
"rowCount": [
{
"TotalRecords": "76"
}
],
"userCount": 1
}
],
"userCount": 1,
"sharedBaseCount": 0
}
}
},
"examples": {
"example-1": {
"value": {
"projectCount": 1,
"projects": [
{
"tableCount": {
"table": 3,
"view": 0
},
"external": false,
"viewCount": {
"formCount": 0,
"gridCount": 3,
"galleryCount": 0,
"kanbanCount": 0,
"total": 3,
"sharedFormCount": 0,
"sharedGridCount": 0,
"sharedGalleryCount": 0,
"sharedKanbanCount": 0,
"sharedTotal": 0,
"sharedLockedCount": 0
},
"webhookCount": 0,
"filterCount": 0,
"sortCount": 0,
"rowCount": [
{
"TotalRecords": "76"
}
],
"userCount": 1
}
],
"userCount": 1,
"sharedBaseCount": 0
}
}
}
},
"application/xml": {
"schema": {

Write Preview
Loading…
Cancel
Save