Browse Source

refactor(nocodb): revise view update and add example in swagger.json

pull/5222/head
Wing-Kam Wong 2 years ago
parent
commit
17607271d8
  1. 61
      packages/nocodb/src/schema/swagger.json

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

@ -12891,36 +12891,63 @@
"description": "Model for View Request", "description": "Model for View Request",
"examples": [ "examples": [
{ {
"title": "Grid View 1",
"uuid": "e2457bbf-e29c-4fec-866e-fe3b01dba57f",
"password": "password123",
"lock_type": "collaborative", "lock_type": "collaborative",
"meta": {}, "meta": "{\"allowCSVDownload\":true}",
"order": 0, "order": 1,
"show_system_fields": true, "show_system_fields": 0
"title": "string"
} }
], ],
"title": "View Request Model",
"type": "object",
"properties": { "properties": {
"title": {
"maxLength": 255,
"type": "string",
"description": "View Title",
"example": "Grid View 1"
},
"uuid": {
"maxLength": 255,
"type": "string",
"x-stoplight": {
"id": "vlhs7xs644u8l"
},
"description": "View UUID. Used in Shared View.",
"example": "e2457bbf-e29c-4fec-866e-fe3b01dba57f"
},
"password": {
"maxLength": 255,
"type": "string",
"x-stoplight": {
"id": "vlhs7xs644u8l"
},
"description": "View Password. Used in Shared View.",
"example": "password123"
},
"lock_type": { "lock_type": {
"enum": ["collaborative", "locked", "personal"], "enum": ["collaborative", "locked", "personal"],
"type": "string" "type": "string",
"description": "Lock type of View.",
"example": "collaborative"
}, },
"meta": { "meta": {
"$ref": "#/components/schemas/Meta" "$ref": "#/components/schemas/Meta",
"description": "Meta info used in View."
}, },
"order": { "order": {
"exclusiveMinimum": true, "type": "number",
"minimum": 0, "description": "The order of the list of views.",
"type": "number" "example": 1,
"minimum": 0
}, },
"show_system_fields": { "show_system_fields": {
"$ref": "#/components/schemas/Bool" "$ref": "#/components/schemas/Bool",
}, "description": "Should this view show system fields?"
"title": {
"maxLength": 255,
"type": "string"
} }
}, }
"title": "View Request Model",
"type": "object"
}, },
"VisibilityRuleReq": { "VisibilityRuleReq": {
"description": "Model for Visibility Rule Request", "description": "Model for Visibility Rule Request",

Loading…
Cancel
Save