Edit node comment

v1.0.0

🚀 Since v4.10.0

Description:

Edit the text of an existing comment for a specific node.

Precondition:

User has 🔓 read permissions on the node and is the creator of the comment.

Postcondition:

Comments text gets changed.

Further Information:

Maximum allowed text length: 65535 characters.

Input

{
  "type": "object",
  "properties": {
    "X-Sds-Auth-Token": {
      "type": "string"
    },
    "X-Sds-Date-Format": {
      "type": "string",
      "enum": [
        "UTC",
        "LOCAL",
        "OFFSET",
        "EPOCH",
        "LEET"
      ]
    },
    "comment_id": {
      "type": "integer",
      "format": "int64"
    },
    "text": {
      "type": "string",
      "description": "Comment text"
    }
  },
  "required": [
    "comment_id",
    "text"
  ],
  "additionalProperties": false
}

Output

{
  "type": "object",
  "description": "Node comment information",
  "required": [
    "createdAt",
    "createdBy",
    "id",
    "isChanged",
    "isDeleted",
    "text",
    "updatedAt",
    "updatedBy"
  ],
  "properties": {
    "createdAt": {
      "type": "string",
      "format": "date-time",
      "description": "Creation date"
    },
    "createdBy": {
      "type": "object",
      "description": "User information",
      "required": [
        "avatarUuid",
        "firstName",
        "id",
        "lastName",
        "userName",
        "userType"
      ],
      "properties": {
        "avatarUuid": {
          "type": "string",
          "description": "&#128640; Since v4.11.0\n\nAvatar UUID"
        },
        "displayName": {
          "type": "string",
          "description": "&#128679; Deprecated since v4.11.0\n\nDisplay name\n\nuse other fields from `UserInfo` instead to combine a display name"
        },
        "email": {
          "type": "string",
          "description": "&#128640; Since v4.11.0\n\nEmail "
        },
        "firstName": {
          "type": "string",
          "description": "&#128640; Since v4.11.0\n\nUser first name (mandatory if `userType` is `internal`)"
        },
        "id": {
          "type": "integer",
          "format": "int64",
          "description": "Unique identifier for the user"
        },
        "lastName": {
          "type": "string",
          "description": "&#128640; Since v4.11.0\n\nUser last name (mandatory if `userType` is `internal`)"
        },
        "title": {
          "type": "string",
          "description": "&#128679; Deprecated since v4.18.0\n\nJob title"
        },
        "userName": {
          "type": "string",
          "description": "&#128640; Since v4.13.0\n\nUsername (only returned for `internal` users)"
        },
        "userType": {
          "type": "string",
          "description": "&#128640; Since v4.11.0\n\nUser type:\n\n* `internal` - ordinary DRACOON user\n\n* `external` - external user without DRACOON account\n\n* `system` - system user (non human &#128125;)\n\n* `deleted` - deleted DRACOON user",
          "enum": [
            "system",
            "internal",
            "external",
            "deleted"
          ]
        }
      }
    },
    "id": {
      "type": "integer",
      "format": "int64",
      "description": "Comment ID"
    },
    "isChanged": {
      "type": "boolean",
      "description": "Determines whether comment was edited or not"
    },
    "isDeleted": {
      "type": "boolean",
      "description": "Determines whether comment was deleted or not"
    },
    "text": {
      "type": "string",
      "description": "Comment text"
    },
    "updatedAt": {
      "type": "string",
      "format": "date-time",
      "description": "Modification date"
    },
    "updatedBy": {
      "type": "object",
      "description": "User information",
      "required": [
        "avatarUuid",
        "firstName",
        "id",
        "lastName",
        "userName",
        "userType"
      ],
      "properties": {
        "avatarUuid": {
          "type": "string",
          "description": "&#128640; Since v4.11.0\n\nAvatar UUID"
        },
        "displayName": {
          "type": "string",
          "description": "&#128679; Deprecated since v4.11.0\n\nDisplay name\n\nuse other fields from `UserInfo` instead to combine a display name"
        },
        "email": {
          "type": "string",
          "description": "&#128640; Since v4.11.0\n\nEmail "
        },
        "firstName": {
          "type": "string",
          "description": "&#128640; Since v4.11.0\n\nUser first name (mandatory if `userType` is `internal`)"
        },
        "id": {
          "type": "integer",
          "format": "int64",
          "description": "Unique identifier for the user"
        },
        "lastName": {
          "type": "string",
          "description": "&#128640; Since v4.11.0\n\nUser last name (mandatory if `userType` is `internal`)"
        },
        "title": {
          "type": "string",
          "description": "&#128679; Deprecated since v4.18.0\n\nJob title"
        },
        "userName": {
          "type": "string",
          "description": "&#128640; Since v4.13.0\n\nUsername (only returned for `internal` users)"
        },
        "userType": {
          "type": "string",
          "description": "&#128640; Since v4.11.0\n\nUser type:\n\n* `internal` - ordinary DRACOON user\n\n* `external` - external user without DRACOON account\n\n* `system` - system user (non human &#128125;)\n\n* `deleted` - deleted DRACOON user",
          "enum": [
            "system",
            "internal",
            "external",
            "deleted"
          ]
        }
      }
    }
  }
}