fix(nocodb): update swagger file for form banner & logo url

9 months ago · f50531cf25
2 changed files with 82 additions and 26 deletions
--- a/packages/nocodb/src/schema/swagger-v2.json
+++ b/packages/nocodb/src/schema/swagger-v2.json
@ -5714,7 +5714,7 @@
              "examples": {
                "Example 1": {
                  "value": {
-                    "banner_image_url": null,
+                    "banner_image_url": "{\"path\":\"download/noco/pm0umqsip16i1u5/m8yn03dncqal6ri//7XeRtAlAOch-9THAFI.png\",\"title\":\"Screenshot 2024-03-01 at 11.24.39 AM.png\",\"mimetype\":\"image/png\",\"size\":392533}",
                    "email": "user@example.com",
                    "heading": "My Form",
                    "lock_type": "collaborative",
@ -5755,7 +5755,7 @@
                  "Example 1": {
                    "value": {
                      "source_id": "ds_g4ccx6e77h1dmi",
-                      "banner_image_url": null,
+                      "banner_image_url": "{\"path\":\"download/noco/pm0umqsip16i1u5/m8yn03dncqal6ri//7XeRtAlAOch-9THAFI.png\",\"title\":\"Screenshot 2024-03-01 at 11.24.39 AM.png\",\"mimetype\":\"image/png\",\"size\":392533,\"signedPath\":\"dltemp/93tI0NcweqZcn7qH/1709286000000/noco/pm0umqsip16i1u5/m8yn03dncqal6ri//7XeRtAlAOch-9THAFI.png\"}",
                      "columns": [
                        {
                          "id": "fvc_ugj9zo5bzocxtl",
@ -12978,7 +12978,7 @@
        "examples": [
          {
            "source_id": "ds_g4ccx6e77h1dmi",
-            "banner_image_url": null,
+            "banner_image_url": "{\"path\":\"download/noco/pm0umqsip16i1u5/m8yn03dncqal6ri//7XeRtAlAOch-9THAFI.png\",\"title\":\"Screenshot 2024-03-01 at 11.24.39 AM.png\",\"mimetype\":\"image/png\",\"size\":392533}",
            "columns": [
              {
                "id": "fvc_ugj9zo5bzocxtl",
@ -13002,7 +13002,7 @@
            "fk_model_id": "md_rsu68aqjsbyqtl",
            "heading": "My Form",
            "lock_type": "collaborative",
-            "logo_url": null,
+            "logo_url": "{\"path\":\"download/noco/pm0umqsip16i1u5/m8yn03dncqal6ri//7XeRtAlAOch-9THAFI.png\",\"title\":\"Screenshot 2024-03-01 at 11.24.39 AM.png\",\"mimetype\":\"image/png\",\"size\":392533}",
            "meta": null,
            "redirect_after_secs": null,
            "redirect_url": null,
@ -13024,8 +13024,15 @@
            }
          },
          "banner_image_url": {
-            "$ref": "#/components/schemas/StringOrNull",
-            "description": "Banner Image URL. Not in use currently."
+            "description": "Banner Image URL",
+            "oneOf": [
+              {
+                "type": "string"
+              },
+              {
+                "type": "null"
+              }
+            ]
          },
          "columns": {
            "type": "array",
@ -13067,8 +13074,15 @@
            "example": "collaborative"
          },
          "logo_url": {
-            "$ref": "#/components/schemas/StringOrNull",
-            "description": "Logo URL. Not in use currently."
+            "description": "Logo URL.",
+            "oneOf": [
+              {
+                "type": "string"
+              },
+              {
+                "type": "null"
+              }
+            ]
          },
          "meta": {
            "$ref": "#/components/schemas/Meta",
@ -13113,7 +13127,7 @@
        "description": "Model for Form Update Request",
        "examples": [
          {
-            "banner_image_url": null,
+            "banner_image_url": "{\"path\":\"download/noco/pm0umqsip16i1u5/m8yn03dncqal6ri//7XeRtAlAOch-9THAFI.png\",\"title\":\"Screenshot 2024-03-01 at 11.24.39 AM.png\",\"mimetype\":\"image/png\",\"size\":392533}",
            "email": "user@example.com",
            "heading": "My Form",
            "logo_url": null,
@ -13130,8 +13144,15 @@
        "type": "object",
        "properties": {
          "banner_image_url": {
-            "$ref": "#/components/schemas/TextOrNull",
-            "description": "Banner Image URL. Not in use currently."
+            "description": "Banner Image URL",
+            "oneOf": [
+              {
+                "type": "string"
+              },
+              {
+                "type": "null"
+              }
+            ]
          },
          "email": {
            "$ref": "#/components/schemas/StringOrNull",
@ -13144,8 +13165,15 @@
            "type": "string"
          },
          "logo_url": {
-            "$ref": "#/components/schemas/TextOrNull",
-            "description": "Logo URL. Not in use currently."
+            "description": "Logo URL.",
+            "oneOf": [
+              {
+                "type": "string"
+              },
+              {
+                "type": "null"
+              }
+            ]
          },
          "meta": {
            "$ref": "#/components/schemas/Meta",
--- a/packages/nocodb/src/schema/swagger.json
+++ b/packages/nocodb/src/schema/swagger.json
@ -7426,7 +7426,7 @@
              "examples": {
                "Example 1": {
                  "value": {
-                    "banner_image_url": null,
+                    "banner_image_url": "{\"path\":\"download/noco/pm0umqsip16i1u5/m8yn03dncqal6ri//7XeRtAlAOch-9THAFI.png\",\"title\":\"Screenshot 2024-03-01 at 11.24.39 AM.png\",\"mimetype\":\"image/png\",\"size\":392533}",
                    "email": "user@example.com",
                    "heading": "My Form",
                    "lock_type": "collaborative",
@ -7467,7 +7467,7 @@
                  "Example 1": {
                    "value": {
                      "source_id": "ds_g4ccx6e77h1dmi",
-                      "banner_image_url": null,
+                      "banner_image_url": "{\"path\":\"download/noco/pm0umqsip16i1u5/m8yn03dncqal6ri//7XeRtAlAOch-9THAFI.png\",\"title\":\"Screenshot 2024-03-01 at 11.24.39 AM.png\",\"mimetype\":\"image/png\",\"size\":392533,\"signedPath\":\"dltemp/93tI0NcweqZcn7qH/1709286000000/noco/pm0umqsip16i1u5/m8yn03dncqal6ri//7XeRtAlAOch-9THAFI.png\"}",
                      "columns": [
                        {
                          "id": "fvc_ugj9zo5bzocxtl",
@ -18620,7 +18620,7 @@
        "examples": [
          {
            "source_id": "ds_g4ccx6e77h1dmi",
-            "banner_image_url": null,
+            "banner_image_url": "{\"path\":\"download/noco/pm0umqsip16i1u5/m8yn03dncqal6ri//7XeRtAlAOch-9THAFI.png\",\"title\":\"Screenshot 2024-03-01 at 11.24.39 AM.png\",\"mimetype\":\"image/png\",\"size\":392533}",
            "columns": [
              {
                "id": "fvc_ugj9zo5bzocxtl",
@ -18644,7 +18644,7 @@
            "fk_model_id": "md_rsu68aqjsbyqtl",
            "heading": "My Form",
            "lock_type": "collaborative",
-            "logo_url": null,
+            "logo_url": "{\"path\":\"download/noco/pm0umqsip16i1u5/m8yn03dncqal6ri//7XeRtAlAOch-9THAFI.png\",\"title\":\"Screenshot 2024-03-01 at 11.24.39 AM.png\",\"mimetype\":\"image/png\",\"size\":392533}",
            "meta": null,
            "redirect_after_secs": null,
            "redirect_url": null,
@ -18666,8 +18666,15 @@
            }
          },
          "banner_image_url": {
-            "$ref": "#/components/schemas/TextOrNull",
-            "description": "Banner Image URL. Not in use currently."
+            "description": "Banner Image URL",
+            "oneOf": [
+              {
+                "type": "string"
+              },
+              {
+                "type": "null"
+              }
+            ]
          },
          "columns": {
            "type": "array",
@ -18709,8 +18716,15 @@
            "example": "collaborative"
          },
          "logo_url": {
-            "$ref": "#/components/schemas/TextOrNull",
-            "description": "Logo URL. Not in use currently."
+            "description": "Logo URL",
+            "oneOf": [
+              {
+                "type": "string"
+              },
+              {
+                "type": "null"
+              }
+            ]
          },
          "meta": {
            "$ref": "#/components/schemas/Meta",
@ -18755,7 +18769,7 @@
        "description": "Model for Form Update Request",
        "examples": [
          {
-            "banner_image_url": null,
+            "banner_image_url": "{\"path\":\"download/noco/pm0umqsip16i1u5/m8yn03dncqal6ri//7XeRtAlAOch-9THAFI.png\",\"title\":\"Screenshot 2024-03-01 at 11.24.39 AM.png\",\"mimetype\":\"image/png\",\"size\":392533}",
            "email": "user@example.com",
            "heading": "My Form",
            "logo_url": null,
@ -18772,8 +18786,15 @@
        "type": "object",
        "properties": {
          "banner_image_url": {
-            "$ref": "#/components/schemas/StringOrNull",
-            "description": "Banner Image URL. Not in use currently."
+            "description": "Banner Image URL",
+            "oneOf": [
+              {
+                "type": "string"
+              },
+              {
+                "type": "null"
+              }
+            ]
          },
          "email": {
            "$ref": "#/components/schemas/StringOrNull",
@ -18786,8 +18807,15 @@
            "type": "string"
          },
          "logo_url": {
-            "$ref": "#/components/schemas/StringOrNull",
-            "description": "Logo URL. Not in use currently."
+            "description": "Logo URL",
+            "oneOf": [
+              {
+                "type": "string"
+              },
+              {
+                "type": "null"
+              }
+            ]
          },
          "meta": {
            "$ref": "#/components/schemas/Meta",