DocumentationAPI reference

Rust · 0.1.0

Delete User Notification

DELETE /api/v1/users/{user}/notifications/{notification}

UserService · UserService_DeleteUserNotification

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.

Successful response

This operation has no resource to return. The Rust REST transport serializes protobuf Empty as HTTP 200 with JSON {}. The empty success-schema area in the generated contract is intentional, not missing request instructions.

Request

DeleteUserNotification deletes a notification.

DELETE/api/v1/users/{user}/notifications/{notification}

Parameters

Name / locationType / requirementDescription
user
path
string
Required
The user id.
notification
path
string
Required
The notification id.

Request body

No request body is declared.

Responses

200 · OK

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": "DeleteUserNotification deletes a notification.",
  "operationId": "UserService_DeleteUserNotification",
  "parameters": [
    {
      "name": "user",
      "in": "path",
      "description": "The user id.",
      "required": true,
      "schema": {
        "type": "string"
      }
    },
    {
      "name": "notification",
      "in": "path",
      "description": "The notification id.",
      "required": true,
      "schema": {
        "type": "string"
      }
    }
  ],
  "responses": {
    "200": {
      "description": "OK",
      "content": {}
    },
    "default": {
      "description": "Default error response",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/Status"
          }
        }
      }
    }
  }
}