Browse Source

refactor(nocodb): kanban & kanbanViewColumn model & add examples

pull/5253/head
Wing-Kam Wong 2 years ago
parent
commit
e611695074
  1. 142
      packages/nocodb/src/schema/swagger.json

142
packages/nocodb/src/schema/swagger.json

@ -11711,89 +11711,135 @@
"description": "Model for Kanban", "description": "Model for Kanban",
"examples": [ "examples": [
{ {
"alias": "string", "id": "vw_wqs4zheuo5lgdy",
"fk_grp_col_id": "cl_3704cxcbqt7sj7",
"fk_view_id": "vw_wqs4zheuo5lgdy",
"fk_cover_image_col_id": null,
"columns": [ "columns": [
{ {
"fk_column_id": "string", "id": "kvc_2skkg5mi1eb37f",
"fk_kanban_id": "string", "fk_column_id": "cl_hzos4ghyncqi4k",
"help": "string", "fk_view_id": "vw_wqs4zheuo5lgdy",
"id": "string", "base_id": "ds_hd4ojj0xpquaam",
"label": "string" "project_id": "p_kzfl5lb0t3tcok",
"title": "string",
"show": 0,
"order": "1"
} }
], ],
"fk_cover_image_col_id": "string", "meta": null,
"fk_grp_col_id": "string", "title": "My Kanban"
"fk_model_id": "string",
"id": "string",
"meta": {},
"title": "string"
} }
], ],
"title": "Kanban Model",
"type": "object",
"properties": { "properties": {
"alias": { "id": {
"type": "string" "$ref": "#/components/schemas/Id",
}, "description": "Unique ID"
"columns": {
"items": {
"$ref": "#/components/schemas/KanbanColumn"
},
"type": "array"
},
"fk_cover_image_col_id": {
"type": "string"
}, },
"fk_grp_col_id": { "fk_grp_col_id": {
"$ref": "#/components/schemas/StringOrNull" "$ref": "#/components/schemas/StringOrNull",
"description": "Grouping Field Column ID"
}, },
"fk_model_id": { "fk_view_id": {
"type": "string" "$ref": "#/components/schemas/Id",
"x-stoplight": {
"id": "1kgw1w06b97nl"
},
"description": "View ID"
}, },
"id": { "fk_cover_image_col_id": {
"$ref": "#/components/schemas/Id", "$ref": "#/components/schemas/Id",
"description": "Unique ID" "description": "Cover Image Column ID"
},
"columns": {
"type": "array",
"description": "Kanban Columns",
"items": {
"$ref": "#/components/schemas/KanbanColumn"
}
}, },
"meta": { "meta": {
"$ref": "#/components/schemas/Meta" "$ref": "#/components/schemas/Meta",
"description": "Meta Info for Kanban"
}, },
"title": { "title": {
"type": "string" "type": "string",
"description": "Kanban Title",
"example": "My Kanban"
} }
}, }
"title": "Kanban Model",
"type": "object"
}, },
"KanbanColumn": { "KanbanColumn": {
"description": "Model for Kanban Column", "description": "Model for Kanban Column",
"examples": [ "examples": [
{ {
"fk_column_id": "string", "id": "kvc_2skkg5mi1eb37f",
"fk_kanban_id": "string", "fk_column_id": "cl_hzos4ghyncqi4k",
"help": "string", "fk_view_id": "vw_wqs4zheuo5lgdy",
"id": "string", "base_id": "ds_hd4ojj0xpquaam",
"label": "string" "project_id": "p_kzfl5lb0t3tcok",
"title": "string",
"show": 0,
"order": "1"
} }
], ],
"title": "Kanban Column Model",
"type": "object",
"properties": { "properties": {
"id": {
"$ref": "#/components/schemas/Id",
"description": "Unique ID"
},
"fk_column_id": { "fk_column_id": {
"$ref": "#/components/schemas/Id", "$ref": "#/components/schemas/Id",
"description": "Foreign Key to Column" "description": "Foreign Key to Column"
}, },
"fk_kanban_id": { "fk_view_id": {
"type": "string" "$ref": "#/components/schemas/Id",
"x-stoplight": {
"id": "t1fy4zy561ih8"
},
"description": "Foreign Key to View"
}, },
"help": { "base_id": {
"type": "string" "$ref": "#/components/schemas/Id",
"x-stoplight": {
"id": "uqq8xmyz97t1u"
},
"description": "Baes ID\n"
}, },
"id": { "project_id": {
"$ref": "#/components/schemas/Id", "$ref": "#/components/schemas/Id",
"description": "Unique ID" "x-stoplight": {
"id": "uqq8xmyz97t1u"
},
"description": "Project ID"
}, },
"label": { "title": {
"x-stoplight": {
"id": "uqq8xmyz97t1u"
},
"description": "Project ID",
"type": "string" "type": "string"
},
"show": {
"$ref": "#/components/schemas/Bool",
"x-stoplight": {
"id": "uqq8xmyz97t1u"
},
"description": "Is this column shown?"
},
"order": {
"type": "number",
"x-stoplight": {
"id": "pbnchzgci5dwa"
},
"example": "1",
"description": "Column Order"
} }
}, }
"title": "Kanban Column Model",
"type": "object"
}, },
"KanbanReq": { "KanbanReq": {
"description": "Model for Kanban Request", "description": "Model for Kanban Request",

Loading…
Cancel
Save