DocumentationAPI reference

Rust · 0.1.0

List Memo Shares

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

MemoService · MemoService_ListMemoShares

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.

Request

ListMemoShares lists all share links for a memo. Requires the memo creator or an instance administrator.

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

Parameters

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

Request body

No request body is declared.

Responses

200 · OK

application/json · ListMemoSharesResponse

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": "ListMemoShares lists all share links for a memo. Requires the memo creator or an instance administrator.",
  "operationId": "MemoService_ListMemoShares",
  "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/ListMemoSharesResponse"
          }
        }
      }
    },
    "default": {
      "description": "Default error response",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/Status"
          }
        }
      }
    }
  }
}