DocumentationAPI reference

Rust · 0.1.0

Delete Memo

DELETE /api/v1/memos/{memo}

MemoService · MemoService_DeleteMemo

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

Requires the memo creator or an instance administrator. Updates and share management also check applicable space placement. Space membership by itself does not grant ownership of another member's memo.

Permanent deletion scope

Deletes the named memo and its owned resources, then cleans up attachment storage. Relations touching it are removed, but related memos and independent comments are not recursively deleted. The declared force input does not enable a different deletion mode. For a reversible workflow, update state to ARCHIVED instead. A cleanup error may arrive after deletion has committed.

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

DeleteMemo deletes only the named memo and its owned resources. It removes incident relations but never deletes another memo.

DELETE/api/v1/memos/{memo}

Parameters

Name / locationType / requirementDescription
memo
path
string
Required
The memo id.
force
query
boolean
Not marked required in OpenAPI
Optional. If set to true, the memo will be deleted even if it has associated data.

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": [
    "MemoService"
  ],
  "description": "DeleteMemo deletes only the named memo and its owned resources. It removes\n incident relations but never deletes another memo.",
  "operationId": "MemoService_DeleteMemo",
  "parameters": [
    {
      "name": "memo",
      "in": "path",
      "description": "The memo id.",
      "required": true,
      "schema": {
        "type": "string"
      }
    },
    {
      "name": "force",
      "in": "query",
      "description": "Optional. If set to true, the memo will be deleted even if it has associated data.",
      "schema": {
        "type": "boolean"
      }
    }
  ],
  "responses": {
    "200": {
      "description": "OK",
      "content": {}
    },
    "default": {
      "description": "Default error response",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/Status"
          }
        }
      }
    }
  }
}