Workspaces API
Workspace endpoints gerem workspaces, members e workspace avatar.
GET /api/v2/workspaces
Devolve a lista de workspaces disponíveis para o account atual.
Argumentos: nenhum.
Payload: nenhum.
Resposta: WorkspaceViewShort[].
GET /api/v2/workspaces/:fullname
Devolve um workspace.
Argumentos:
| Argumento | Localização | Descrição |
|---|---|---|
fullname | Path | Workspace fullname. |
Payload: nenhum.
Resposta: WorkspaceView.
PUT /api/v2/workspaces/:fullname
Cria novo workspace ou atualiza existente.
Argumentos:
| Argumento | Localização | Descrição |
|---|---|---|
fullname | Path | Workspace fullname. Deve coincidir com payload.fullname. |
Payload:
| Campo | Obrigatório | Descrição |
|---|---|---|
fullname | Sim | Workspace fullname. |
createOnly | Não | Se true, endpoint devolve erro se workspace já existir. |
resetInvite | Não | Regenera invite state. |
tags | Não | Array de tags. |
labels | Não | Objeto com labels string. |
meta.title | Não | Título visível do workspace. |
meta.avatar | Não | Avatar URL. |
Resposta: WorkspaceView.
DELETE /api/v2/workspaces/:fullname
Elimina workspace.
Argumentos:
| Argumento | Localização | Descrição |
|---|---|---|
fullname | Path | Workspace fullname. |
Payload: nenhum.
Resposta: OperationResult.
POST /api/v2/workspaces/:fullname/avatar
Envia o avatar do workspace.
Argumentos:
| Argumento | Localização | Descrição |
|---|---|---|
fullname | Path | Workspace fullname. |
Payload:
| Campo | Obrigatório | Descrição |
|---|---|---|
filename | Sim | Nome original do ficheiro. |
contentType | Sim | MIME type da imagem. |
data | Sim | Dados da imagem em Base64. |
Resposta: AvatarUploadResult.
GET /api/v2/workspaces/:workspace/acl
Devolve lista de members/ACL entries do workspace.
Argumentos:
| Argumento | Localização | Descrição |
|---|---|---|
workspace | Path | Workspace fullname. |
Payload: nenhum.
Resposta: WorkspaceAclEntry[].
POST /api/v2/workspaces/:workspace/acl
Cria invite ou ACL entry.
Argumentos:
| Argumento | Localização | Descrição |
|---|---|---|
workspace | Path | Workspace fullname. |
Payload:
| Campo | Obrigatório | Descrição |
|---|---|---|
invite | Sim | Invite id/token. |
Resposta: WorkspaceAclEntry.
PUT /api/v2/workspaces/:workspace/acl/:entryId
Altera papel de member.
Argumentos:
| Argumento | Localização | Descrição |
|---|---|---|
workspace | Path | Workspace fullname. |
entryId | Path | ACL entry id. |
Payload:
| Campo | Obrigatório | Descrição |
|---|---|---|
level | Sim | Um de owner, admin, developer, user. |
Resposta: WorkspaceAclEntry.
DELETE /api/v2/workspaces/:workspace/acl/:entryId
Elimina member/ACL entry.
Argumentos:
| Argumento | Localização | Descrição |
|---|---|---|
workspace | Path | Workspace fullname. |
entryId | Path | ACL entry id. |
Payload: nenhum.
Resposta: OperationResult.