feat(swagger): add api in swagger

Signed-off-by: Pranav C <pranavxc@gmail.com>
2 years ago · 15ee45922d
2 changed files with 175 additions and 0 deletions
--- a/packages/nocodb-sdk/src/lib/Api.ts
+++ b/packages/nocodb-sdk/src/lib/Api.ts
@ -3301,6 +3301,22 @@ export class Api<
        ...params,
      }),

+    /**
+     * No description
+     *
+     * @tags Utils
+     * @name AggregatedMetaInfo
+     * @request GET:/api/v1/aggregated-meta-info
+     * @response `200` `any` OK
+     */
+    aggregatedMetaInfo: (params: RequestParams = {}) =>
+      this.request<any, any>({
+        path: `/api/v1/aggregated-meta-info`,
+        method: 'GET',
+        format: 'json',
+        ...params,
+      }),
+
    /**
     * @description Get All K/V pairs in NocoCache
     *
--- a/scripts/sdk/swagger.json
+++ b/scripts/sdk/swagger.json
@ -5337,6 +5337,165 @@
        "description": ""
      }
    },
+    "/api/v1/aggregated-meta-info": {
+      "parameters": [],
+      "get": {
+        "summary": "",
+        "operationId": "utils-aggregated-meta-info",
+        "responses": {
+          "200": {
+            "description": "OK",
+            "content": {
+              "application/json": {
+                "schema": {}
+              },
+              "application/xml": {
+                "schema": {
+                  "type": "object",
+                  "properties": {
+                    "projectCount": {
+                      "type": "integer"
+                    },
+                    "projects": {
+                      "type": "array",
+                      "items": {
+                        "type": "object",
+                        "properties": {
+                          "tableCount": {
+                            "type": "object",
+                            "properties": {
+                              "table": {
+                                "type": "integer"
+                              },
+                              "view": {
+                                "type": "integer"
+                              }
+                            }
+                          },
+                          "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"
+                              },
+                              "sharedPasswordProtected": {
+                                "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
+                          },
+                          "viewCount": {
+                            "formCount": 0,
+                            "gridCount": 3,
+                            "galleryCount": 0,
+                            "kanbanCount": 0,
+                            "total": 3,
+                            "sharedFormCount": 0,
+                            "sharedGridCount": 0,
+                            "sharedGalleryCount": 0,
+                            "sharedKanbanCount": 0,
+                            "sharedTotal": 0,
+                            "sharedPasswordProtected": 0
+                          },
+                          "webhookCount": 0,
+                          "filterCount": 0,
+                          "sortCount": 0,
+                          "rowCount": [
+                            {
+                              "TotalRecords": "76"
+                            }
+                          ],
+                          "userCount": 1
+                        }
+                      ],
+                      "userCount": 1,
+                      "sharedBaseCount": 0
+                    }
+                  }
+                },
+                "examples": {
+                  "example-1": {
+                    "value": "{\n  \"projectCount\": 1,\n  \"projects\": [\n    {\n      \"tableCount\": {\n        \"table\": 3,\n        \"view\": 0\n      },\n      \"viewCount\": {\n        \"formCount\": 0,\n        \"gridCount\": 3,\n        \"galleryCount\": 0,\n        \"kanbanCount\": 0,\n        \"total\": 3,\n        \"sharedFormCount\": 0,\n        \"sharedGridCount\": 0,\n        \"sharedGalleryCount\": 0,\n        \"sharedKanbanCount\": 0,\n        \"sharedTotal\": 0,\n        \"sharedPasswordProtected\": 0\n      },\n      \"webhookCount\": 0,\n      \"filterCount\": 0,\n      \"sortCount\": 0,\n      \"rowCount\": [\n        {\n          \"TotalRecords\": \"76\"\n        }\n      ],\n      \"userCount\": 1\n    }\n  ],\n  \"userCount\": 1,\n  \"sharedBaseCount\": 0\n}"
+                  }
+                }
+              }
+            }
+          }
+        },
+        "tags": [
+          "Utils"
+        ],
+        "description": ""
+      }
+    },
    "/api/v1/db/meta/cache": {
      "get": {
        "summary": "Your GET endpoint",