Rust · 0.1.0

List User Notifications

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

UserService · UserService_ListUserNotifications

Protocol-derived reference. Authorization and instance policy still apply. Schema descriptions are inherited from the MIT-licensed application contract; examples here are not executed against a live server.

Access

Owner-only: the user named in the path must be the authenticated caller. Instance administrator status does not allow acting on another account here.

Visibility-filtered inbox

Returns the owner's current readable notifications in newest-first order. The reserved pageSize, pageToken and filter inputs are ignored. Notifications whose subject is no longer readable can disappear from this projection even if a stored inbox record remains; the owner may still delete such an entry by name.

Request

ListUserNotifications lists notifications for a user.

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

Parameters

Name / location	Type / requirement	Description
`user` path	string Required	The user id.
`pageSize` query	integer (int32) Not marked required in OpenAPI
`pageToken` query	string Not marked required in OpenAPI
`filter` query	string Not marked required in OpenAPI

Request body

No request body is declared.

Responses

200 · OK

application/json · ListUserNotificationsResponse

default · Default error response

application/json · Status

Complete operation definition

All declared constraints, media types and response details are retained below. Schema references link to their complete definitions.

Open JSON definition

{
  "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"
          }
        }
      }
    }
  }
}