USusememos
MemoService

PATCH /api/memos/{memo}

Changed on

UpdateMemo updates the memo fields listed in update_mask. Requires the memo creator or an instance administrator.

Request

  • The document declares no server URL.
  • Auth
    none declared

Path parameters

memostring required

The memo id.

Query parameters

updateMaskstring field-mask

Required. The fields to update. Supported paths: content, visibility, space, pinned, state, create_time, update_time, location, attachments, relations.

Request body

namestring

Identifier. The resource name of the memo, where memo is the user-defined UID. Format: memos/{memo}

creatorstring

Output only. The resource name of the creator. Format: users/{user}

spacestring

Optional. The space in which the memo is placed. Every memo, including a comment, owns its placement independently. Format: spaces/{space}

contentstring required

Required. The content of the memo in Markdown. Must not exceed the instance's content length limit.

visibility'VISIBILITY_UNSPECIFIED' | 'PRIVATE' | 'PROTECTED' | 'PUBLIC' | 'SPACE' enum required

Required. The visibility of the memo. Defaults to PRIVATE on creation when unspecified. SPACE requires the memo to be placed in a space.

state'STATE_UNSPECIFIED' | 'NORMAL' | 'ARCHIVED' enum required

Required. The state of the memo. New memos are always NORMAL; change it with UpdateMemo.

pinnedboolean

Optional. Whether the memo is pinned. Ignored on creation; change it with UpdateMemo.

parentstring

Output only. The context memo of this COMMENT relation, if any. Its identity is returned even when the caller cannot read the parent. Fetch the parent independently; this field does not grant read access. Format: memos/{memo}

tagsstring[]

Output only. The tags extracted from the content.

snippetstring

Output only. A plain-text snippet of the content.

createTimestring date-time

Optional. The creation time. Defaults to the current time when unset on creation.

updateTimestring date-time

Optional. The last update time. Defaults to the current time when unset on creation.

Response

OK

namestring

Identifier. The resource name of the memo, where memo is the user-defined UID. Format: memos/{memo}

creatorstring

Output only. The resource name of the creator. Format: users/{user}

spacestring

Optional. The space in which the memo is placed. Every memo, including a comment, owns its placement independently. Format: spaces/{space}

contentstring required

Required. The content of the memo in Markdown. Must not exceed the instance's content length limit.

visibility'VISIBILITY_UNSPECIFIED' | 'PRIVATE' | 'PROTECTED' | 'PUBLIC' | 'SPACE' enum required

Required. The visibility of the memo. Defaults to PRIVATE on creation when unspecified. SPACE requires the memo to be placed in a space.

state'STATE_UNSPECIFIED' | 'NORMAL' | 'ARCHIVED' enum required

Required. The state of the memo. New memos are always NORMAL; change it with UpdateMemo.

pinnedboolean

Optional. Whether the memo is pinned. Ignored on creation; change it with UpdateMemo.

parentstring

Output only. The context memo of this COMMENT relation, if any. Its identity is returned even when the caller cannot read the parent. Fetch the parent independently; this field does not grant read access. Format: memos/{memo}

tagsstring[]

Output only. The tags extracted from the content.

snippetstring

Output only. A plain-text snippet of the content.

createTimestring date-time

Optional. The creation time. Defaults to the current time when unset on creation.

updateTimestring date-time

Optional. The last update time. Defaults to the current time when unset on creation.

Changes

  • 5bf4947d4d29Revision changes
    • info

      added the new optional request property /////

    • info

      added the optional property ///// to the response with the status

  • 1846a777b0efRevision changes
    • info

      endpoint added