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

refactor(nocodb): revise grid model & add examples in swagger.json

pull/5253/head
Wing-Kam Wong 2 years ago
parent
0e7365e118
commit
9a3e697003
1 changed files with 639 additions and 63 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. 702
      packages/nocodb/src/schema/swagger.json

702
packages/nocodb/src/schema/swagger.json
Unescape View File

@ -16,11 +16,7 @@
},
{
"name": "Data APIs",
"tags": [
"DB Table Row",
"DB View Row",
"Storage"
]
"tags": ["DB Table Row", "DB View Row", "Storage"]
},
{
"name": "Meta APIs",
@ -42,12 +38,7 @@
},
{
"name": "Organisation APIs",
"tags": [
"Org App Settings",
"Org License",
"Org Tokens",
"Org Users"
]
"tags": ["Org App Settings", "Org License", "Org Tokens", "Org Users"]
}
],
"servers": [
@ -133,6 +124,14 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/SignUpReq"
},
"examples": {
"Example 1": {
"value": {
"email": "user@example.com",
"password": "password123456789"
}
}
}
}
}
@ -184,6 +183,13 @@
"description": "The signed JWT token for information exchange"
}
}
},
"examples": {
"Example 1": {
"value": {
"token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJlbWFpbCI6IndAbm9jb2RiLmNvbSIsImZpcnN0bmFtZSI6bnVsbCwibGFzdG5hbWUiOm51bGwsImlkIjoidXNfYjN4bzJpNDRueDV5OWwiLCJyb2xlcyI6Im9yZy1sZXZlbC1jcmVhdG9yLHN1cGVyIiwidG9rZW5fdmVyc2lvbiI6ImJmMTc3ZGUzYjk3YjAzMjY4YjU0NGZmMjMzNGU5YjFhMGUzYzgxM2NiYzliOTJkYWMwYmM5NTRiNmUzN2ZjMTJjYmFkNDM2NmIwYzExZTdjIiwiaWF0IjoxNjc4MDc4NDMyLCJleHAiOjE2NzgxMTQ0MzJ9.gzwp_svZlbA5PV_eawYV-9UFjZVjniy-tCDce16xrkI"
}
}
}
}
}
@ -289,6 +295,13 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/PasswordForgotReq"
},
"examples": {
"Example 1": {
"value": {
"email": "user@example.com"
}
}
}
}
},
@ -445,6 +458,13 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/PasswordResetReq"
},
"examples": {
"Example 1": {
"value": {
"password": "newpassword"
}
}
}
}
}
@ -481,7 +501,8 @@
"description": "New access token for user"
}
}
}
},
"examples": {}
}
}
}
@ -532,6 +553,30 @@
"required": ["list", "pageInfo"]
}
}
},
"examples": {
"Example 1": {
"value": {
"users": {
"list": [
{
"id": "1",
"fk_user_id": "us_b3xo2i44nx5y9l",
"description": "This API Token is for ABC application",
"token": "DYh540o8hbWpUGdarekECKLdN5OhlgCUWutVJYX2",
"created_by": "string"
}
],
"pageInfo": {
"isFirstPage": true,
"isLastPage": true,
"page": 1,
"pageSize": 10,
"totalRows": 1
}
}
}
}
}
}
}
@ -610,6 +655,13 @@
"description": "Application license key"
}
}
},
"examples": {
"Example 1": {
"value": {
"key": "195f7bcc-c3e1-43c5-b23c-8d8127280e7d"
}
}
}
}
}
@ -665,6 +717,13 @@
"example": true
}
}
},
"examples": {
"Example 1": {
"value": {
"invite_only_signup": true
}
}
}
}
}
@ -739,6 +798,31 @@
"required": ["list", "pageInfo"]
}
}
},
"examples": {
"Example 1": {
"value": {
"users": {
"list": [
{
"email": "user@example.com",
"email_verified": true,
"firstname": "Alice",
"id": "us_8kugj628ebjngs",
"lastname": "Smith",
"roles": "org-level-viewer"
}
],
"pageInfo": {
"isFirstPage": true,
"isLastPage": true,
"page": 1,
"pageSize": 10,
"totalRows": 1
}
}
}
}
}
}
}
@ -810,6 +894,14 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/OrgUserReq"
},
"examples": {
"Example 1": {
"value": {
"email": "user@example.com",
"roles": "org-level-creator"
}
}
}
}
},
@ -887,7 +979,8 @@
"description": "Password Reset URL for the user"
}
}
}
},
"examples": {}
}
}
}
@ -925,6 +1018,31 @@
"required": ["list", "pageInfo"]
}
}
},
"examples": {
"Example 1": {
"value": {
"users": {
"list": [
{
"email": "user@example.com",
"email_verified": true,
"firstname": "Alice",
"id": "us_8kugj628ebjngs",
"lastname": "Smith",
"roles": "org-level-viewer"
}
],
"pageInfo": {
"isFirstPage": true,
"isLastPage": true,
"page": 1,
"pageSize": 10,
"totalRows": 1
}
}
}
}
}
}
}
@ -1046,6 +1164,20 @@
"example": "1.0.0"
}
}
},
"examples": {
"Example 1": {
"value": {
"Node": "v12.16.1",
"Arch": "x64",
"Platform": "linux",
"Docker": false,
"Database": "postgres",
"ProjectOnRootDB": false,
"RootDB": "postgres",
"PackageVersion": "1.0.0"
}
}
}
}
}
@ -1322,8 +1454,39 @@
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {}
"$ref": "#/components/schemas/Project"
},
"examples": {
"Example 1": {
"value": {
"bases": [
{
"alias": "string",
"config": null,
"enabled": true,
"id": "string",
"inflection_column": "camelize",
"inflection_table": "camelize",
"is_meta": true,
"order": 1,
"project_id": "string",
"type": "mysql2",
"updated_at": "2023-03-01 14:27:36"
}
],
"color": "#24716E",
"created_at": "2023-03-01 14:27:36",
"deleted": true,
"description": "This is my project description",
"id": "p_124hhlkbeasewh",
"is_meta": true,
"meta": {},
"order": 0,
"prefix": "nc_vm5q__",
"status": "string",
"title": "my-project"
}
}
}
}
}
@ -1405,8 +1568,24 @@
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {}
"$ref": "#/components/schemas/Base"
},
"examples": {
"Example 1": {
"value": {
"alias": null,
"config": "<ENCRYPTED>",
"enabled": 1,
"id": "ds_krsappzu9f8vmo",
"inflection_column": "camelize",
"inflection_table": "camelize",
"is_meta": 1,
"meta": null,
"order": 1,
"project_id": "p_01clqvzik3izk6",
"type": "mysql2"
}
}
}
}
}
@ -1595,6 +1774,15 @@
"example": "viewer"
}
}
},
"examples": {
"Example 1": {
"value": {
"uuid": "a0eebc99-9c0b-4ef8-bb6d-6bb9bd380a11",
"url": "http://example.com",
"roles": "viewer"
}
}
}
}
}
@ -1690,6 +1878,14 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/SharedBaseReq"
},
"examples": {
"Example 1": {
"value": {
"password": "password123",
"roles": "editor"
}
}
}
}
}
@ -3128,6 +3324,13 @@
"type": "number"
}
}
},
"examples": {
"Example 1": {
"value": {
"order": 0
}
}
}
}
}
@ -3345,6 +3548,19 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/ViewReq"
},
"examples": {
"Example 1": {
"value": {
"title": "Grid View 1",
"uuid": "e2457bbf-e29c-4fec-866e-fe3b01dba57f",
"password": "password123",
"lock_type": "collaborative",
"meta": "{\"allowCSVDownload\":true}",
"order": 1,
"show_system_fields": 0
}
}
}
}
}
@ -3724,6 +3940,25 @@
}
}
}
},
"examples": {
"Example 1": {
"value": {
"sorts": {
"list": [
{
"id": "so_xd4t51uv60ghzl",
"fk_column_id": "cl_l11b769pe2j1ce",
"fk_model_id": "md_ehn5izr99m7d45",
"base_id": "ds_3l9qx8xqksenrl",
"direction": "desc",
"order": 1,
"project_id": "p_9sx43moxhqtjm3"
}
]
}
}
}
}
}
}
@ -3790,6 +4025,19 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/Sort"
},
"examples": {
"Example 1": {
"value": {
"id": "so_xd4t51uv60ghzl",
"fk_column_id": "cl_l11b769pe2j1ce",
"fk_model_id": "md_ehn5izr99m7d45",
"base_id": "ds_3l9qx8xqksenrl",
"direction": "desc",
"order": 1,
"project_id": "p_9sx43moxhqtjm3"
}
}
}
}
}
@ -3812,6 +4060,14 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/SortReq"
},
"examples": {
"Example 1": {
"value": {
"direction": "asc",
"fk_column_id": "cl_l11b769pe2j1ce"
}
}
}
}
}
@ -3856,6 +4112,29 @@
"items": {
"$ref": "#/components/schemas/Filter"
}
},
"examples": {
"Example 1": {
"value": [
{
"base_id": "ds_g4ccx6e77h1dmi",
"comparison_op": "eq",
"comparison_sub_op": null,
"created_at": "2023-03-02 18:18:05",
"fk_column_id": "cl_d7ah9n2qfupgys",
"fk_hook_id": null,
"fk_parent_id": null,
"fk_view_id": "vw_b739e29vqmrxnf",
"id": "fi_xn647tpmdq8fu8",
"is_group": null,
"logical_op": "and",
"order": 1,
"project_id": "p_xm3thidrblw4n7",
"updated_at": "2023-03-02 18:18:05",
"value": "foo"
}
]
}
}
}
}
@ -3906,6 +4185,18 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/FilterReq"
},
"examples": {
"Example 1": {
"value": {
"comparison_op": "eq",
"comparison_sub_op": null,
"fk_column_id": "cl_d7ah9n2qfupgys",
"is_group": false,
"logical_op": "and",
"value": "foo"
}
}
}
}
}
@ -3993,6 +4284,27 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/Filter"
},
"examples": {
"Example 1": {
"value": {
"base_id": "ds_g4ccx6e77h1dmi",
"comparison_op": "eq",
"comparison_sub_op": null,
"created_at": "2023-03-02 18:18:05",
"fk_column_id": "cl_d7ah9n2qfupgys",
"fk_hook_id": null,
"fk_parent_id": null,
"fk_view_id": "vw_b739e29vqmrxnf",
"id": "fi_xn647tpmdq8fu8",
"is_group": null,
"logical_op": "and",
"order": 1,
"project_id": "p_xm3thidrblw4n7",
"updated_at": "2023-03-02 18:18:05",
"value": "foo"
}
}
}
}
}
@ -4059,6 +4371,29 @@
"items": {
"$ref": "#/components/schemas/Filter"
}
},
"examples": {
"Example 1": {
"value": [
{
"base_id": "ds_g4ccx6e77h1dmi",
"comparison_op": "eq",
"comparison_sub_op": null,
"created_at": "2023-03-02 18:18:05",
"fk_column_id": "cl_d7ah9n2qfupgys",
"fk_hook_id": null,
"fk_parent_id": null,
"fk_view_id": "vw_b739e29vqmrxnf",
"id": "fi_xn647tpmdq8fu8",
"is_group": null,
"logical_op": "and",
"order": 1,
"project_id": "p_xm3thidrblw4n7",
"updated_at": "2023-03-02 18:18:05",
"value": "foo"
}
]
}
}
}
}
@ -4224,6 +4559,46 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/Form"
},
"examples": {
"Example 1": {
"value": {
"base_id": "ds_g4ccx6e77h1dmi",
"banner_image_url": null,
"columns": [
{
"id": "fvc_ugj9zo5bzocxtl",
"base_id": "ds_g4ccx6e77h1dmi",
"project_id": "p_xm3thidrblw4n7",
"fk_view_id": "vw_kdf5cr7qmhksek",
"fk_column_id": "cl_phvuuwjrzcdo0g",
"uuid": null,
"label": null,
"help": null,
"description": null,
"required": null,
"show": 0,
"order": 1,
"created_at": "2023-03-04 16:40:47",
"updated_at": "2023-03-04 16:40:47",
"meta": {}
}
],
"email": "user@example.com",
"fk_model_id": "md_rsu68aqjsbyqtl",
"heading": "My Form",
"lock_type": "collaborative",
"logo_url": null,
"meta": null,
"redirect_after_secs": null,
"redirect_url": null,
"show_blank_form": 0,
"subheading": "My Form Subheading",
"submit_another_form": 0,
"success_msg": "Thank you for the submission.",
"title": "Form View 1"
}
}
}
}
}
@ -4257,6 +4632,19 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/FormColumnReq"
},
"examples": {
"Example 1": {
"value": {
"description": null,
"help": "This is a help text",
"label": "Form Label",
"meta": null,
"order": 1,
"required": 0,
"show": 0
}
}
}
}
}
@ -4307,6 +4695,55 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/Grid"
},
"examples": {
"Example 1": {
"value": {
"project_id": "p_xm3thidrblw4n7",
"base_id": "ds_g4ccx6e77h1dmi",
"fk_view_id": "vw_p2jcatxz4mvcfw",
"row_height": 1,
"meta": null,
"columns": [
{
"id": "cl_phvuuwjrzcdo0g",
"base_id": "ds_g4ccx6e77h1dmi",
"project_id": "p_xm3thidrblw4n7",
"fk_model_id": "md_rsu68aqjsbyqtl",
"title": "Id",
"column_name": "id",
"uidt": "ID",
"dt": "int",
"np": "10",
"ns": "0",
"clen": null,
"cop": "1",
"pk": 1,
"pv": null,
"rqd": 1,
"un": 1,
"ct": "int unsigned",
"ai": 1,
"unique": 0,
"cdf": null,
"cc": "",
"csn": null,
"dtx": "specificType",
"dtxp": "",
"dtxs": "0",
"au": 0,
"validate": null,
"virtual": null,
"deleted": null,
"system": 0,
"order": 1,
"created_at": "2023-03-02 17:04:06",
"updated_at": "2023-03-02 17:04:06",
"meta": null
}
]
}
}
}
}
}
@ -4338,6 +4775,23 @@
"items": {
"$ref": "#/components/schemas/GridColumn"
}
},
"examples": {
"Example 1": {
"value": [
{
"id": "nc_c8jz4kxe6xvh11",
"fk_view_id": "vw_p2jcatxz4mvcfw",
"fk_column_id": "cl_c5knoi4xs4sfpt",
"project_id": "p_xm3thidrblw4n7",
"base_id": "ds_g4ccx6e77h1dmi",
"show": 0,
"order": 1,
"width": "200px",
"help": null
}
]
}
}
}
}
@ -4380,6 +4834,15 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/GridColumnReq"
},
"examples": {
"Example 1": {
"value": {
"fk_column_id": "cl_c5knoi4xs4sfpt",
"label": "My Column",
"width": "200px"
}
}
}
}
}
@ -10603,82 +11066,195 @@
"description": "Model for Grid",
"examples": [
{
"alias": "string",
"deleted": true,
"id": "string",
"lock_type": "collaborative",
"order": 0,
"row_height": 0,
"title": "string"
"project_id": "p_xm3thidrblw4n7",
"base_id": "ds_g4ccx6e77h1dmi",
"fk_view_id": "vw_p2jcatxz4mvcfw",
"row_height": 1,
"meta": null,
"columns": [
{
"id": "cl_phvuuwjrzcdo0g",
"base_id": "ds_g4ccx6e77h1dmi",
"project_id": "p_xm3thidrblw4n7",
"fk_model_id": "md_rsu68aqjsbyqtl",
"title": "Id",
"column_name": "id",
"uidt": "ID",
"dt": "int",
"np": "10",
"ns": "0",
"clen": null,
"cop": "1",
"pk": 1,
"pv": null,
"rqd": 1,
"un": 1,
"ct": "int unsigned",
"ai": 1,
"unique": 0,
"cdf": null,
"cc": "",
"csn": null,
"dtx": "specificType",
"dtxp": "",
"dtxs": "0",
"au": 0,
"validate": null,
"virtual": null,
"deleted": null,
"system": 0,
"order": 1,
"created_at": "2023-03-02 17:04:06",
"updated_at": "2023-03-02 17:04:06",
"meta": null
}
]
}
],
"title": "Grid Model",
"type": "object",
"properties": {
"alias": {
"type": "string"
},
"deleted": {
"$ref": "#/components/schemas/Bool"
},
"id": {
"$ref": "#/components/schemas/Id",
"description": "Unique ID"
"description": "Unique ID",
"x-stoplight": {
"id": "e3ti3fc0ocjyu"
}
},
"lock_type": {
"enum": ["collaborative", "locked", "personal"],
"type": "string"
"project_id": {
"$ref": "#/components/schemas/Id",
"description": "Project ID",
"x-stoplight": {
"id": "e3ti3fc0ocjyu"
}
},
"order": {
"type": "number"
"base_id": {
"$ref": "#/components/schemas/Id",
"description": "Base ID",
"x-stoplight": {
"id": "m8v3iyf1tidy9"
}
},
"fk_view_id": {
"$ref": "#/components/schemas/Id",
"description": "Foreign Key to View",
"x-stoplight": {
"id": "m8v3iyf1tidy9"
}
},
"row_height": {
"type": "number"
"type": "number",
"example": 1,
"description": "Row Height"
},
"title": {
"type": "string"
}
"meta": {
"$ref": "#/components/schemas/Meta",
"x-stoplight": {
"id": "n8cud3jyqw5yv"
},
"title": "Grid Model",
"type": "object"
"description": "Meta info for Grid Model"
},
"columns": {
"type": "array",
"x-stoplight": {
"id": "22y0gipx2jdf8"
},
"description": "Grid View Columns",
"items": {
"$ref": "#/components/schemas/GridColumn",
"x-stoplight": {
"id": "nmzp6w3o6b24u"
}
}
}
}
},
"GridColumn": {
"description": "Model for Grid Column",
"examples": [
{
"fk_column_id": "string",
"help": "string",
"id": "string",
"label": "string",
"width": "string"
"id": "nc_c8jz4kxe6xvh11",
"fk_view_id": "vw_p2jcatxz4mvcfw",
"fk_column_id": "cl_c5knoi4xs4sfpt",
"project_id": "p_xm3thidrblw4n7",
"base_id": "ds_g4ccx6e77h1dmi",
"show": 0,
"order": 1,
"width": "200px",
"help": null
}
],
"title": "Grid Column Model",
"type": "object",
"properties": {
"id": {
"$ref": "#/components/schemas/Id",
"description": "Unique ID",
"x-stoplight": {
"id": "jc14yojp52rqj"
}
},
"fk_view_id": {
"$ref": "#/components/schemas/Id",
"description": "Foreign Key to View",
"x-stoplight": {
"id": "vl18dbt5c2r8r"
}
},
"fk_column_id": {
"$ref": "#/components/schemas/Id",
"description": "Foreign Key to Column"
"description": "Foreign Key to Column",
"x-stoplight": {
"id": "2drg88fmodf3v"
}
},
"help": {
"type": "string"
"project_id": {
"$ref": "#/components/schemas/Id",
"description": "Project ID",
"x-stoplight": {
"id": "2drg88fmodf3v"
}
},
"id": {
"description": "Unique ID of Grid Column",
"type": "string"
"base_id": {
"$ref": "#/components/schemas/Id",
"description": "Base ID",
"x-stoplight": {
"id": "2drg88fmodf3v"
}
},
"label": {
"type": "string"
"show": {
"$ref": "#/components/schemas/Bool",
"x-stoplight": {
"id": "d47eer13oa8yr"
}
},
"order": {
"type": "number",
"x-stoplight": {
"id": "d47eer13oa8yr"
},
"example": "1",
"description": "Grid Column Order"
},
"width": {
"type": "string"
}
"type": "string",
"description": "Column Width",
"example": "200px"
},
"title": "Grid Column Model",
"type": "object"
"help": {
"$ref": "#/components/schemas/StringOrNull",
"description": "Column Help Text",
"x-stoplight": {
"id": "azwh6zn37qzkc"
}
}
}
},
"GridColumnReq": {
"description": "Model for Grid Column Request",
"examples": [
{
"fk_column_id": "string",
"help": "string",
"fk_column_id": "cl_c5knoi4xs4sfpt",
"label": "My Column",
"width": "200px"
}
@ -13601,9 +14177,9 @@
{
"email": "user@example.com",
"email_verified": true,
"firstName": "Alice",
"firstname": "Alice",
"id": "us_8kugj628ebjngs",
"lastName": "Smith",
"lastname": "Smith",
"roles": "org-level-viewer"
}
],

Write Preview
Loading…
Cancel
Save