DocumentationAPI reference

Rust · 0.1.0

Get Memo

GET /api/v1/memos/{memo}

MemoService · MemoService_GetMemo

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.

Read a named resource

Use the name returned by creation or listing to find the UID. This operation returns a hydrated Memo including readable attachments, reactions and references. A returned parent name is context only; fetch the parent separately and handle its access result. Named-resource administrator access can be broader than feed visibility.

Request

GetMemo gets a memo.

GET/api/v1/memos/{memo}

Parameters

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

Request body

No request body is declared.

Responses

200 · OK

application/json · Memo

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