DocumentationAPI reference

Rust · 0.1.0

Update Memo View

PATCH /api/v1/users/{user}/views/{view}

UserService · UserService_UpdateMemoView

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

UpdateMemoView updates a memo view for a user.

PATCH/api/v1/users/{user}/views/{view}

Parameters

Name / locationType / requirementDescription
user
path
string
Required
The user id.
view
path
string
Required
The view id.
updateMask
query
string (field-mask)
Not marked required in OpenAPI
Optional. The list of fields to update.

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": "UpdateMemoView updates a memo view for a user.",
  "operationId": "UserService_UpdateMemoView",
  "parameters": [
    {
      "name": "user",
      "in": "path",
      "description": "The user id.",
      "required": true,
      "schema": {
        "type": "string"
      }
    },
    {
      "name": "view",
      "in": "path",
      "description": "The view id.",
      "required": true,
      "schema": {
        "type": "string"
      }
    },
    {
      "name": "updateMask",
      "in": "query",
      "description": "Optional. The list of fields to update.",
      "schema": {
        "type": "string",
        "format": "field-mask"
      }
    }
  ],
  "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"
          }
        }
      }
    }
  }
}