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

refactor(nocodb): revise form view column mode & add example

pull/5222/head
Wing-Kam Wong 2 years ago
parent
b523edaf98
commit
009531ae67
1 changed files with 107 additions and 111 deletions
Whitespace
Show all changes Ignore whitespace when comparing lines Ignore changes in amount of whitespace Ignore changes in whitespace at EOL
Unified View
Diff Options
Show Stats Download Patch File Download Diff File
  1. 218
      packages/nocodb/src/schema/swagger.json

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

@ -3131,7 +3131,26 @@
"content": { "content": {
"application/json": { "application/json": {
"schema": { "schema": {
"$ref": "#/components/schemas/FormCreateReq" "$ref": "#/components/schemas/FormReq"
},
"examples": {
"Example 1": {
"value": {
"banner_image_url": null,
"email": "user@example.com",
"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"
}
}
} }
} }
} }
@ -8961,7 +8980,7 @@
}, },
"base_id": { "base_id": {
"type": "string", "type": "string",
"description": "Base I", "description": "Base ID",
"example": "md_rsu68aqjsbyqtl", "example": "md_rsu68aqjsbyqtl",
"x-stoplight": { "x-stoplight": {
"id": "kfz7tve8nzj6f" "id": "kfz7tve8nzj6f"
@ -9107,66 +9126,19 @@
"description": "Model for Form Column", "description": "Model for Form Column",
"examples": [ "examples": [
{ {
"created_at": "string", "id": "fvc_1m9b0aub791d4m",
"description": "string", "description": null,
"fk_column_id": "string", "fk_column_id": "cl_ah9zavkn25ihyd",
"fk_view_id": "string", "fk_view_id": "vw_6fqln9vdytdv8q",
"help": null, "help": "This is a help text",
"id": "string", "label": "Form Label",
"label": "string", "meta": null,
"meta": {}, "order": 1,
"order": 0, "required": 0,
"required": true, "show": 0,
"show": true,
"updated_at": "string",
"uuid": null "uuid": null
} }
], ],
"properties": {
"created_at": {
"minLength": 1,
"type": "string"
},
"description": {
"minLength": 1,
"type": "string"
},
"fk_column_id": {
"$ref": "#/components/schemas/Id",
"description": "Foreign Key to Column",
"minLength": 1
},
"fk_view_id": {
"minLength": 1,
"type": "string"
},
"help": {},
"id": {
"minLength": 1,
"type": "string"
},
"label": {
"minLength": 1,
"type": "string"
},
"meta": {
"$ref": "#/components/schemas/Meta"
},
"order": {
"type": "number"
},
"required": {
"$ref": "#/components/schemas/Bool"
},
"show": {
"$ref": "#/components/schemas/Bool"
},
"updated_at": {
"minLength": 1,
"type": "string"
},
"uuid": {}
},
"title": "Form Column Model", "title": "Form Column Model",
"type": "object", "type": "object",
"x-examples": { "x-examples": {
@ -9186,47 +9158,67 @@
"updated_at": "2022-02-15 12:39:16", "updated_at": "2022-02-15 12:39:16",
"uuid": null "uuid": null
} }
} },
},
"FormColumnReq": {
"description": "Model for Form Column Request",
"examples": [
{
"description": "string",
"help": "string",
"label": "string",
"meta": {},
"order": 0,
"required": true,
"show": true
}
],
"properties": { "properties": {
"id": {
"$ref": "#/components/schemas/Id",
"description": "Unique ID"
},
"description": { "description": {
"maxLength": 255, "$ref": "#/components/schemas/StringOrNull",
"type": "string" "description": "Form Column Description (Not in use)"
},
"fk_column_id": {
"$ref": "#/components/schemas/Id",
"description": "Foreign Key to Column"
},
"fk_view_id": {
"$ref": "#/components/schemas/Id"
}, },
"help": { "help": {
"maxLength": 255 "$ref": "#/components/schemas/StringOrNull",
"description": "Form Column Help Text"
}, },
"label": { "label": {
"maxLength": 255, "$ref": "#/components/schemas/StringOrNull",
"minLength": 1, "description": "Form Column Label"
"type": "string"
}, },
"meta": { "meta": {
"$ref": "#/components/schemas/Meta" "$ref": "#/components/schemas/Meta",
"description": "Meta Info"
}, },
"order": { "order": {
"type": "number" "type": "number",
"description": "The order among all the columns in the form",
"example": 1
}, },
"required": { "required": {
"$ref": "#/components/schemas/Bool" "$ref": "#/components/schemas/Bool",
"description": "Is this form column required in submission?"
}, },
"show": { "show": {
"$ref": "#/components/schemas/Bool" "$ref": "#/components/schemas/Bool",
"description": "Is this column shown in Form?"
},
"uuid": {
"$ref": "#/components/schemas/StringOrNull",
"description": "Form Column UUID (Not in use)"
} }
}, }
},
"FormColumnReq": {
"description": "Model for Form Column Request",
"examples": [
{
"description": null,
"help": "This is a help text",
"label": "Form Label",
"meta": null,
"order": 1,
"required": 0,
"show": 0
}
],
"title": "Form Column Request Model", "title": "Form Column Request Model",
"type": "object", "type": "object",
"x-examples": { "x-examples": {
@ -9246,33 +9238,37 @@
"updated_at": "2022-02-15 12:39:16", "updated_at": "2022-02-15 12:39:16",
"uuid": null "uuid": null
} }
} },
}, "properties": {
"FormCreateReq": { "description": {
"allOf": [ "$ref": "#/components/schemas/StringOrNull",
{ "description": "Form Column Description (Not in use)"
"$ref": "#/components/schemas/FormReq" },
} "help": {
], "$ref": "#/components/schemas/StringOrNull",
"description": "Model for Form Create", "description": "Form Column Help Text"
"examples": [ },
{ "label": {
"banner_image_url": "string", "$ref": "#/components/schemas/StringOrNull",
"email": "string", "description": "Form Column Label"
"heading": "My Form", },
"lock_type": "collaborative", "meta": {
"logo_url": "string", "$ref": "#/components/schemas/Meta",
"meta": {}, "description": "Meta Info"
"redirect_after_secs": "string", },
"redirect_url": "string", "order": {
"show_blank_form": true, "type": "number",
"subheading": "My Form Subheading", "description": "The order among all the columns in the form"
"submit_another_form": true, },
"success_msg": "string", "required": {
"title": "My Form" "$ref": "#/components/schemas/Bool",
"description": "Is this form column required in submission?"
},
"show": {
"$ref": "#/components/schemas/Bool",
"description": "Is this column shown in Form?"
} }
], }
"title": "Form Create Model"
}, },
"Formula": { "Formula": {
"description": "Model for Formula", "description": "Model for Formula",

Write Preview
Loading…
Cancel
Save