Rust · 0.1.0

List Memo Relations

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

MemoService · MemoService_ListMemoRelations

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

The resource must be readable by the caller. Anonymous access depends on public instance policy and the memo's visibility. Unlinked attachments require their owner or an instance administrator. A resource name alone does not grant access.

Request

ListMemoRelations lists relations for a memo.

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

Parameters

Name / location	Type / requirement	Description
`memo` path	string Required	The memo id.
`pageSize` query	integer (int32) Not marked required in OpenAPI	Optional. The maximum number of relations to return.
`pageToken` query	string Not marked required in OpenAPI	Optional. A page token for pagination.

Request body

No request body is declared.

Responses

200 · OK

application/json · ListMemoRelationsResponse

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": "ListMemoRelations lists relations for a memo.",
  "operationId": "MemoService_ListMemoRelations",
  "parameters": [
    {
      "name": "memo",
      "in": "path",
      "description": "The memo id.",
      "required": true,
      "schema": {
        "type": "string"
      }
    },
    {
      "name": "pageSize",
      "in": "query",
      "description": "Optional. The maximum number of relations to return.",
      "schema": {
        "type": "integer",
        "format": "int32"
      }
    },
    {
      "name": "pageToken",
      "in": "query",
      "description": "Optional. A page token for pagination.",
      "schema": {
        "type": "string"
      }
    }
  ],
  "responses": {
    "200": {
      "description": "OK",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/ListMemoRelationsResponse"
          }
        }
      }
    },
    "default": {
      "description": "Default error response",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/Status"
          }
        }
      }
    }
  }
}