PATCH /api/v1/projects/{projectId}

PATCH/api/v1/projects/{projectId}

更新项目（需 admin 及以上，API Key 不可用）

projectoperationId: projectUpdate

请求参数

名称	类型	位置	必填	说明
`projectId`	string	path	是	项目 ID（UUID）。携带 `X-API-Key` 时按 API Key scope 鉴权，否则按 JWT + 项目成员角色鉴权

请求体

请求数据

Content-Type · application/json

{
  "type": "object",
  "properties": {
    "name": {
      "type": "string"
    },
    "slug": {
      "type": "string"
    },
    "description": {
      "type": "string",
      "description": "传入即整体覆盖，空值会清空"
    }
  }
}

请求示例

cURL

curl -X PATCH 'http://localhost:8080/api/v1/projects/{projectId}' \
  -H 'Accept: application/json' \
  -H 'X-API-Key: <PROJECT_API_KEY>'
# 也可使用登录会话：-H 'Authorization: Bearer <JWT>'

JavaScript

const res = await fetch('http://localhost:8080/api/v1/projects/{projectId}', {
  method: 'PATCH',
  headers: {
    'Accept': 'application/json',
    'X-API-Key': '<PROJECT_API_KEY>'
  },
});
const data = await res.json();

Python

import requests

res = requests.patch(
    'http://localhost:8080/api/v1/projects/{projectId}',
    headers={'Accept': 'application/json', 'X-API-Key': '<PROJECT_API_KEY>'}
)
print(res.json())

响应

200操作成功

application/json

{
  "type": "object",
  "properties": {
    "status": {
      "type": "string",
      "example": "ok"
    }
  }
}

400请求参数错误

application/json

{
  "type": "object",
  "properties": {
    "code": {
      "type": "string",
      "example": "not_found"
    },
    "message": {
      "type": "string",
      "example": "资源不存在"
    }
  }
}

403无权限（未通过 RBAC 或 2FA）

application/json

{
  "type": "object",
  "properties": {
    "code": {
      "type": "string",
      "example": "not_found"
    },
    "message": {
      "type": "string",
      "example": "资源不存在"
    }
  }
}

在线调试

凭证仅保存在当前页面内存中

请求地址projectIdBearer Token

自定义请求 Header

请求体 · application/json