DocumentationAPI reference

Rust · 0.1.0

Create Memo View

POST /api/v1/users/{user}/views

UserService · UserService_CreateMemoView

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

Owner-only: the user named in the path must be the authenticated caller. Instance administrator status does not allow acting on another account here.

A view stores a filter

A saved view needs a nonempty title and valid, nonempty ListMemos filter. It does not copy or grant access to matching memos. CreateMemoView supports validateOnly; UpdateMemoView supports title, filter and icon masks. Including icon in the mask and omitting it from the body resets the icon.

Request

CreateMemoView creates a new memo view for a user.

POST/api/v1/users/{user}/views

Parameters

Name / locationType / requirementDescription
user
path
string
Required
The user id.
validateOnly
query
boolean
Not marked required in OpenAPI
Optional. If set, validate the request, but do not actually create the memo view.

Request body

Required

application/json · MemoView

Responses

200 · OK

application/json · MemoView

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": [
    "UserService"
  ],
  "description": "CreateMemoView creates a new memo view for a user.",
  "operationId": "UserService_CreateMemoView",
  "parameters": [
    {
      "name": "user",
      "in": "path",
      "description": "The user id.",
      "required": true,
      "schema": {
        "type": "string"
      }
    },
    {
      "name": "validateOnly",
      "in": "query",
      "description": "Optional. If set, validate the request, but do not actually create the memo view.",
      "schema": {
        "type": "boolean"
      }
    }
  ],
  "requestBody": {
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/MemoView"
        }
      }
    },
    "required": true
  },
  "responses": {
    "200": {
      "description": "OK",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/MemoView"
          }
        }
      }
    },
    "default": {
      "description": "Default error response",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/Status"
          }
        }
      }
    }
  }
}