Files
cloudpods/docs/schemas/region.yaml
T

68 lines
1.3 KiB
YAML

RegionListResponse:
type: object
properties:
limit:
type: integer
example: 20
offset:
type: integer
example: 0
total:
type: integer
description: 总量
regions:
type: array
items:
$ref: "#/Region"
RegionGetResponse:
type: object
properties:
region:
type: object
$ref: "#/Region"
RegionPutRequestInput:
type: object
properties:
name:
type: string
description: 区域的名称
description:
type: string
description: 区域的描述
RegionCreateInput:
type: object
properties:
id:
type: string
required: true
description: 区域的ID,全局唯一
example: Beijing, Tianjin
name:
type: string
description: 区域的名称,默认和ID一样,也可以不一样
example: 北京
description:
type: string
description: 区域的描述
Region:
type: object
description: 区域
properties:
id:
type: string
description: 区域ID
readOnly: true
name:
type: string
description: 区域名,全局唯一
can_delete:
type: boolean
description: 是否可以删除
description:
type: string
description: 区域的描述信息