Box · Schema

Comment (Full)

Comments are messages created on files. Comments can be made independently or created as responses to other comments

Cloud StorageCollaborationContent ManagementDocumentsEnterpriseFile Sharing
View JSON Schema on GitHub

JSON Schema

box-comment-full-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/Comment--Full",
  "title": "Comment (Full)",
  "type": "object",
  "x-box-resource-id": "comment--full",
  "x-box-variant": "full",
  "description": "Comments are messages created on files. Comments\ncan be made independently or created as responses to other\ncomments",
  "allOf": [
    {
      "$ref": "#/components/schemas/Comment"
    },
    {
      "properties": {
        "tagged_message": {
          "type": "string",
          "example": "@[1234567:Aaron Levie] these tigers are cool!",
          "description": "The string representing the comment text with\n@mentions included. @mention format is @[id:username]\nwhere `id` is user's Box ID and `username` is\ntheir display name."
        }
      }
    }
  ]
}