文档API 参考

Rust · 0.1.0

List User Notifications

GET /api/v1/users/{user}/notifications

UserService · UserService_ListUserNotifications

基于协议生成的参考。授权与实例策略仍然生效。结构描述继承自 MIT 许可的应用接口定义;本站不会向真实服务执行示例。

访问权限

仅限所有者:路径中的用户必须是已认证调用者;实例管理员身份不允许在此代替其他账号操作。

按可见性筛选的收件箱

按从新到旧返回所有者当前可读的通知。保留的 pageSize、pageToken 与 filter 输入被忽略。通知主题不再可读时,即使收件箱记录仍存储,也可能不再出现在投影中;所有者仍可按 name 删除这样的条目。

请求

ListUserNotifications lists notifications for a user.

GET/api/v1/users/{user}/notifications

参数

名称 / 位置类型 / 是否必需描述
user
path
string
必需
The user id.
pageSize
query
integer (int32)
OpenAPI 未标记为必需
pageToken
query
string
OpenAPI 未标记为必需
filter
query
string
OpenAPI 未标记为必需

请求体

未声明请求体。

响应

200 · OK

application/json · ListUserNotificationsResponse

default · Default error response

application/json · Status

完整操作定义

下方保留全部已声明约束、媒体类型和响应细节。结构引用链接到完整定义。

展开 JSON 定义
{
  "tags": [
    "UserService"
  ],
  "description": "ListUserNotifications lists notifications for a user.",
  "operationId": "UserService_ListUserNotifications",
  "parameters": [
    {
      "name": "user",
      "in": "path",
      "description": "The user id.",
      "required": true,
      "schema": {
        "type": "string"
      }
    },
    {
      "name": "pageSize",
      "in": "query",
      "schema": {
        "type": "integer",
        "format": "int32"
      }
    },
    {
      "name": "pageToken",
      "in": "query",
      "schema": {
        "type": "string"
      }
    },
    {
      "name": "filter",
      "in": "query",
      "schema": {
        "type": "string"
      }
    }
  ],
  "responses": {
    "200": {
      "description": "OK",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/ListUserNotificationsResponse"
          }
        }
      }
    },
    "default": {
      "description": "Default error response",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/Status"
          }
        }
      }
    }
  }
}