Docs: change uischema doc (#516)

Signed-off-by: barnettZQG <barnett.zqg@gmail.com>

docs/reference/ui-schema.md

@@ -41,21 +41,29 @@ Its workflow is in the figure above. The API Schema is generated through the def
 
 The spec are as follows:
 
-```
+```yaml
-- jsonKey: string         field name
+- jsonKey: string         The field name
-  label: string           show name in UI
+  label: string           The show name in UI
-  description: string     help info
+  description: string     The help info in UI
-  uiType: string          the react component type in UI
+  uiType: string          The react component type in UI
-  sort: int               sort number
+  sort: int               The sort number
-  validate:               data validate rule.
+  disabled: bool          Disable this field.
+  style:  
+    colSpan: int          Defines the number of grids for the form, with 24 representing 100% width.
+  validate:               The value validate rule, It must be defined as a whole. 
+    defaultValue: any     The default values.
     required: bool
-    max: int
+    max: int              The max value for number.
-    min: int
+    min: int              The min value for number.
+    maxLength: int        The max length for string.
+    minLength: int        The min length for string.
     pattern: string
     options:              Optional, for select forms
     - label: string
       value: string
+    immutable: bool       Set the immutable is true, indicates that the parameter cannot be changed.
   subParameters:
+    - jsonKey: string
       ...
 ```
 
@@ -85,6 +93,7 @@ The spec are as follows:
 - [ ] PVCSelect
 - [x] CPUNumber
 - [x] MemoryNumber
+- [x] DiskNumber
 - [x] K8sObjectsCode
 
 #### Combination form
@@ -93,9 +102,12 @@ The spec are as follows:
 - [x] Strings
 - [x] Structs
 - [x] Group: render as a titled container
-- [x] InnerGroup
 - [ ] TabGroup
 
+### Example
+
+Ref：[https://github.com/oam-dev/catalog/tree/master/addons/velaux/schemas](https://github.com/oam-dev/catalog/tree/master/addons/velaux/schemas)
+
 ### How to expand
 
 UI-Schema mainly extends front-end react components, refer to [https://github.com/oam-dev/velaux/tree/main/src/extends](https://github.com/oam-dev/velaux/tree/main/src/extends)

i18n/zh/docusaurus-plugin-content-docs/current/reference/ui-schema.md

@@ -41,21 +41,29 @@ template: {
 
 UI Schema 包含的字段如下：
 
-```
+```yaml
 - jsonKey: string             字段名称
   label: string UI            显示名称
   description: string         描述信息
   uiType: string              UI 组件类型
   sort: int                   排序
-  validate:  数据校验规则
+  disabled: bool              是否禁用该字段
-    required: bool 是否必填
+  style:                      样式定义
-    max: int 最大值
+    colSpan: int              表单栅格大小，24 代表 100% 宽度
-    min: int 最小值
+  validate:                   数据校验规则，自定义后整体替换默认配置
+    defaultValue: any         默认值
+    required: bool            是否是必填参数
+    max: int                  数字最大值
+    min: int                  数字最小值
+    maxLength: int            最大字符长度
+    minLength: int            最小字符长度
     pattern: string           正则校验规则
     options:                  可选项，适用于选择性表单
     - label: string           可选项显示名称
       value: string           可选项值
-  subParameters: 下级参数
+    immutable: bool           是否为不可变字段，设为 true 则代表该字段不能在编辑中更改。
+  subParameters:              下级参数，结构一致
+    - jsonKey: string
       ...
 ```
 
@@ -85,6 +93,7 @@ UI Schema 包含的字段如下：
 - [ ] PVCSelect: 目标集群的存储卷选择 （参数：clusterName, namespace）
 - [x] CPUNumber: cpu 数值输入框 支持小数点后 2 位，默认单位为 Core
 - [x] MemoryNumber: 内存数值输入框 2^n 数值输入方式，默认单位为 MB
+- [x] DiskNumber: 默认单位为 GB
 - [x] K8sObjectsCode: kubernetes yaml 编辑框，支持上传 yaml，输出多个 k8s 资源对象。
 
 #### 组合表单
@@ -96,9 +105,13 @@ UI Schema 包含的字段如下：
   > AddByKV:env.name|env.value
   > AddBySecret:env.name|env.valueFrom
 - [x] Group: 组合（渲染为一个带标题的容器)
-- [x] InnerGroup: 行内组合容器
 - [ ] TabGroup: 条件判断 Tab，只有一组生效。
 
+
+### 配置案例
+
+参考：[https://github.com/oam-dev/catalog/tree/master/addons/velaux/schemas](https://github.com/oam-dev/catalog/tree/master/addons/velaux/schemas)
+
 ### 如何扩展
 
 UI-Schema 主要扩展的是前端组件，参考 [https://github.com/oam-dev/velaux/tree/main/src/extends](https://github.com/oam-dev/velaux/tree/main/src/extends)

i18n/zh/docusaurus-plugin-content-docs/version-v1.2/reference/ui-schema.md

@@ -41,21 +41,29 @@ template: {
 
 UI Schema 包含的字段如下：
 
-```
+```yaml
 - jsonKey: string             字段名称
   label: string UI            显示名称
   description: string         描述信息
   uiType: string              UI 组件类型
   sort: int                   排序
-  validate:  数据校验规则
+  disabled: bool              是否禁用该字段
-    required: bool 是否必填
+  style:                      样式定义
-    max: int 最大值
+    colSpan: int              表单栅格大小，24 代表 100% 宽度
-    min: int 最小值
+  validate:                   数据校验规则，自定义后整体替换默认配置
+    defaultValue: any         默认值
+    required: bool            是否是必填参数
+    max: int                  数字最大值
+    min: int                  数字最小值
+    maxLength: int            最大字符长度
+    minLength: int            最小字符长度
     pattern: string           正则校验规则
     options:                  可选项，适用于选择性表单
     - label: string           可选项显示名称
       value: string           可选项值
-  subParameters: 下级参数
+    immutable: bool           是否为不可变字段，设为 true 则代表该字段不能在编辑中更改。
+  subParameters:              下级参数，结构一致
+    - jsonKey: string
       ...
 ```
 
@@ -85,6 +93,7 @@ UI Schema 包含的字段如下：
 - [ ] PVCSelect: 目标集群的存储卷选择 （参数：clusterName, namespace）
 - [x] CPUNumber: cpu 数值输入框 支持小数点后 2 位，默认单位为 Core
 - [x] MemoryNumber: 内存数值输入框 2^n 数值输入方式，默认单位为 MB
+- [x] DiskNumber: 默认单位为 GB
 - [x] K8sObjectsCode: kubernetes yaml 编辑框，支持上传 yaml，输出多个 k8s 资源对象。
 
 #### 组合表单
@@ -96,9 +105,13 @@ UI Schema 包含的字段如下：
   > AddByKV:env.name|env.value
   > AddBySecret:env.name|env.valueFrom
 - [x] Group: 组合（渲染为一个带标题的容器)
-- [x] InnerGroup: 行内组合容器
 - [ ] TabGroup: 条件判断 Tab，只有一组生效。
 
+
+### 配置案例
+
+参考：[https://github.com/oam-dev/catalog/tree/master/addons/velaux/schemas](https://github.com/oam-dev/catalog/tree/master/addons/velaux/schemas)
+
 ### 如何扩展
 
 UI-Schema 主要扩展的是前端组件，参考 [https://github.com/oam-dev/velaux/tree/main/src/extends](https://github.com/oam-dev/velaux/tree/main/src/extends)

versioned_docs/version-v1.2/reference/ui-schema.md

@@ -41,21 +41,29 @@ Its workflow is in the figure above. The API Schema is generated through the def
 
 The spec are as follows:
 
-```
+```yaml
-- jsonKey: string         field name
+- jsonKey: string         The field name
-  label: string           show name in UI
+  label: string           The show name in UI
-  description: string     help info
+  description: string     The help info in UI
-  uiType: string          the react component type in UI
+  uiType: string          The react component type in UI
-  sort: int               sort number
+  sort: int               The sort number
-  validate:               data validate rule.
+  disabled: bool          Disable this field.
+  style:  
+    colSpan: int          Defines the number of grids for the form, with 24 representing 100% width.
+  validate:               The value validate rule, It must be defined as a whole. 
+    defaultValue: any     The default values.
     required: bool
-    max: int
+    max: int              The max value for number.
-    min: int
+    min: int              The min value for number.
+    maxLength: int        The max length for string.
+    minLength: int        The min length for string.
     pattern: string
     options:              Optional, for select forms
     - label: string
       value: string
+    immutable: bool       Set the immutable is true, indicates that the parameter cannot be changed.
   subParameters:
+    - jsonKey: string
       ...
 ```
 
@@ -85,6 +93,7 @@ The spec are as follows:
 - [ ] PVCSelect
 - [x] CPUNumber
 - [x] MemoryNumber
+- [x] DiskNumber
 - [x] K8sObjectsCode
 
 #### Combination form
@@ -93,9 +102,12 @@ The spec are as follows:
 - [x] Strings
 - [x] Structs
 - [x] Group: render as a titled container
-- [x] InnerGroup
 - [ ] TabGroup
 
+### Example
+
+Ref：[https://github.com/oam-dev/catalog/tree/master/addons/velaux/schemas](https://github.com/oam-dev/catalog/tree/master/addons/velaux/schemas)
+
 ### How to expand
 
 UI-Schema mainly extends front-end react components, refer to [https://github.com/oam-dev/velaux/tree/main/src/extends](https://github.com/oam-dev/velaux/tree/main/src/extends)