com.pimstash.planner.comment Documentation (EN)

main record

A comment on a Card. It names no author: the repository is its author.

Record Key any Any valid record key

Properties

board string record-key Required

The record key of the com.pimstash.planner.board, in this same repository, this record belongs to.

body string Required

Markdown.

maxLength: 10000 bytesminLength: 1 bytes

card string record-key Required

The record key of the com.pimstash.planner.card, on the same Board, this comment is on.

createdAt string datetime Required

An RFC 3339 formatted timestamp.

editedAt string datetime Optional

Set once the comment is changed after posting.

View raw schema

{
  "description": "A comment on a Card. It names no author: the repository is its author.",
  "key": "any",
  "record": {
    "properties": {
      "board": {
        "description": "The record key of the com.pimstash.planner.board, in this same repository, this record belongs to.",
        "format": "record-key",
        "type": "string"
      },
      "body": {
        "description": "Markdown.",
        "maxLength": 10000,
        "minLength": 1,
        "type": "string"
      },
      "card": {
        "description": "The record key of the com.pimstash.planner.card, on the same Board, this comment is on.",
        "format": "record-key",
        "type": "string"
      },
      "createdAt": {
        "format": "datetime",
        "type": "string"
      },
      "editedAt": {
        "description": "Set once the comment is changed after posting.",
        "format": "datetime",
        "type": "string"
      }
    },
    "required": [
      "board",
      "card",
      "body",
      "createdAt"
    ],
    "type": "object"
  },
  "type": "record"
}