DocumentationAPI reference

Rust · 0.1.0

Set Memo Relations

PATCH /api/v1/memos/{memo}/relations

MemoService · MemoService_SetMemoRelations

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.

Replace outgoing references

Send the full desired array of REFERENCE relations, each identifying a readable target in relatedMemo.name. COMMENT cannot be created or modified here; an empty array clears references while preserving comment context. The caller must be able to read each target. Self-references are ignored and duplicate targets are collapsed.

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

SetMemoRelations replaces the full set of mutable REFERENCE relations on a memo. COMMENT relations are immutable creation context and are rejected by this RPC. An empty list clears references without changing COMMENT.

PATCH/api/v1/memos/{memo}/relations

Parameters

Name / locationType / requirementDescription
memo
path
string
Required
The memo id.

Request body

Required

application/json · SetMemoRelationsRequest

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": "SetMemoRelations replaces the full set of mutable REFERENCE relations on a\n memo. COMMENT relations are immutable creation context and are rejected by\n this RPC. An empty list clears references without changing COMMENT.",
  "operationId": "MemoService_SetMemoRelations",
  "parameters": [
    {
      "name": "memo",
      "in": "path",
      "description": "The memo id.",
      "required": true,
      "schema": {
        "type": "string"
      }
    }
  ],
  "requestBody": {
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/SetMemoRelationsRequest"
        }
      }
    },
    "required": true
  },
  "responses": {
    "200": {
      "description": "OK",
      "content": {}
    },
    "default": {
      "description": "Default error response",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/Status"
          }
        }
      }
    }
  }
}