FieldSpec

更新时间:
复制 MD 格式

名称

类型

描述

示例值

object

字段规格

name

string

字段名称,值格式为小写字母数字字符(可含 - _ .)。

order_id

type

string

字段类型:string、integer、float、boolean、time、json_object、json_array。

string

display_name

string

显示名,供界面展示,可含中文。

订单号

description

string

字段的业务含义描述。

交易订单的唯一编号

short_description

string

简短描述(一句话),用于列表等紧凑展示场景。

订单编号

unit

string

字段单位,仅用于展示,不做自动换算(如 ms 不会自动换算为 s)。

ms

data_format

string

数值/展示格式化方式,如 KMB(千/百万/十亿)、percent(百分比)、ms、dthms(时:分:秒)等。

KMB

launch_stage

string

字段的发布阶段:preview、beta、ga、deprecated。

ga

analysable

boolean

是否可分析,即是否可作为 Group By 的维度列。

true

filterable

boolean

是否可过滤,即是否支持索引过滤查询。

true

orderable

boolean

是否可排序。

true

value_mapping

object

枚举值映射:key 为原始值,value 为映射后的语义名,用于展示枚举值的业务含义(如 status 字段值 1 映射为 running)。

string

映射后的语义名。

running