Rust · 0.1.0

List Memo Comments

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

MemoService · MemoService_ListMemoComments

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.

Newest readable comments first

Requires access to the parent and separately filters each comment by its own visibility. Only NORMAL comments are listed. Pagination works, but the declared orderBy input is ignored: results remain newest-first by creation time and ID. A comment can exist while being absent from your results.

Request

ListMemoComments lists comments for a memo.

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

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 comments to return.
`pageToken` query	string Not marked required in OpenAPI	Optional. A page token for pagination.
`orderBy` query	string Not marked required in OpenAPI	Optional. The order to sort results by.

Request body

No request body is declared.

Responses

200 · OK

application/json · ListMemoCommentsResponse

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