Files
cloudpods/docs/schemas/project.yaml
Qiu Jian e1f35f67e7 fix: deprecate old user/group joint project API, create new action apis
for add user/group to projects with roles
2019-08-17 18:44:33 +08:00

141 lines
2.9 KiB
YAML

ProjectListResponse:
type: object
properties:
limit:
type: integer
example: 20
offset:
type: integer
example: 0
total:
type: integer
description: 总量
projects:
type: array
items:
$ref: "#/Project"
ProjectGetResponse:
type: object
properties:
project:
type: object
$ref: "#/Project"
ProjectPutRequestInput:
type: object
properties:
name:
type: string
description: 项目的名称
description:
type: string
description: 项目的描述
ProjectCreateInput:
type: object
properties:
name:
type: string
required: true
description: 项目的名称
description:
type: string
description: 项目的描述
Project:
type: object
description: 项目
properties:
id:
type: string
description: 项目ID
readOnly: true
name:
type: string
description: 项目名,全局唯一
can_delete:
type: boolean
description: 是否可以删除
ProjectJoinRequestInput:
type: object
description: 用户或组批量加入项目的请求body
properties:
projects:
type: array
description: 项目列表
items:
type: string
roles:
type: array
description: 角色列表
items:
type: string
ProjectLeaveRequestInput:
type: object
description: 用户或组批量移除项目的请求body
properties:
project_roles:
type: array
description: 移除的项目和角色列表
items:
type: object
properties:
project:
type: string
description: 项目ID或名称
role:
type: string
description: 角色ID或名称
ProjectJoinUserGroupRequestInput:
type: object
description: 将多个用户或组批量加入指定项目的请求body
properties:
users:
type: array
description: 加入的用户列表
items:
type: string
groups:
type: array
description: 加入的组列表
items:
type: string
roles:
type: array
description: 加入的角色列表
items:
type: string
ProjectRemoveUserGroupRequestInput:
type: object
description: 将多个用户或组从指定项目移除的请求body
properties:
user_roles:
type: array
description: 用户和角色列表
items:
type: object
properties:
user:
type: string
description: 用户ID或名称
role:
type: string
description: 角色ID或名称
group_roles:
type: array
description: 组和角色列表
items:
type: object
properties:
group:
type: string
description: 组ID或名称
role:
type: string
description: 角色ID或名称