PPanel Edge

me

由 openapi.json 自动生成的 3 个端点及其请求、响应和权限元数据。

此参考由已发布 API 契约生成。字段、请求头和权限要求如下。

下载完整 OpenAPI 文档 · SHA-256: ccaa20cec11fad96e369b88073ce3608a5b071ce55d6dc03fa31df7b0f08c525

标识符和数据结构与公开契约一致,说明直接给出调用规则。共享模型见 数据模型.

GET /api/v1/me

GET /api/v1/me

Profile, language, time zone and the capabilities of the signed-in user

{
  "responses": {
    "200": {
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/Me"
          }
        }
      },
      "description": "Profile",
      "headers": {
        "ETag": {
          "description": "Current resource version for If-Match.",
          "schema": {
            "type": "string"
          }
        }
      }
    }
  },
  "summary": "Profile, language, time zone and the capabilities of the signed-in user",
  "tags": [
    "me"
  ],
  "x-body": "none",
  "x-body-limit": 0,
  "x-concurrency": {
    "etag": true
  },
  "effectiveSecurity": []
}

PATCH /api/v1/me

PATCH /api/v1/me

Update name, language or time zone (If-Match)

{
  "parameters": [
    {
      "description": "Resource ETag; missing 428, malformed 412, stale 409.",
      "in": "header",
      "name": "If-Match",
      "required": true,
      "schema": {
        "type": "string"
      }
    }
  ],
  "requestBody": {
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/MePatch"
        }
      }
    },
    "required": true
  },
  "responses": {
    "200": {
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/Me"
          }
        }
      },
      "description": "Updated",
      "headers": {
        "ETag": {
          "description": "Current resource version for If-Match.",
          "schema": {
            "type": "string"
          }
        }
      }
    }
  },
  "summary": "Update name, language or time zone (If-Match)",
  "tags": [
    "me"
  ],
  "x-audit": "me.profile.update",
  "x-body": "json",
  "x-body-limit": 65536,
  "x-concurrency": {
    "etag": true,
    "ifMatch": true
  },
  "x-idempotency": "none",
  "effectiveSecurity": []
}

POST /api/v1/me/invitations/{id}/accept

POST /api/v1/me/invitations/{id}/accept

Accept an invitation as a registered user (roles merged, referrer unchanged)

{
  "parameters": [
    {
      "in": "path",
      "name": "id",
      "required": true,
      "schema": {
        "maxLength": 64,
        "type": "string"
      }
    }
  ],
  "responses": {
    "200": {
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/InvitationAccepted"
          }
        }
      },
      "description": "Accepted"
    }
  },
  "summary": "Accept an invitation as a registered user (roles merged, referrer unchanged)",
  "tags": [
    "me"
  ],
  "x-audit": "me.invitation.accept",
  "x-body": "none",
  "x-body-limit": 0,
  "x-idempotency": "none",
  "effectiveSecurity": []
}