Files
cloudpods/docs/schemas/region.yaml
2019-06-29 15:22:39 +08:00

68 lines
1.3 KiB
YAML
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

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: 区域的描述信息