com.guineeeeeeeeeeeeeeeeeeeeeeeerm.patch Documentation (EN)

main record

A change to what readers see of a post, recorded without editing the text itself. Patches apply in order of createdAt, then id.

Record Key tid Timestamp-based ID

Properties

anchor string Required

Text that appears exactly once in the post as it currently reads.

createdAt string datetime Required

When this record was written (UTC).

id string Required

Name of the patch, unique on the site (lowercase letters, digits and hyphens).

lang string Optional

Which version the patch changes: ko or en. Absent means ko.

Known values: ko, en

op string Required

What to do at the anchor: replace it, insert text before or after it, or delete it.

Known values: replace, insert-before, insert-after, delete

post string Required

Id of the post this record belongs to (the rkey of its com.guineeeeeeeeeeeeeeeeeeeeeeeerm.post record, YYYYMMDD-HHMMSS).

text string Optional

The new text. Required for replace, insert-before and insert-after; absent for delete.

why string Required

Why the author made this change, in their own words.

View raw schema

{
  "description": "A change to what readers see of a post, recorded without editing the text itself. Patches apply in order of createdAt, then id.",
  "key": "tid",
  "record": {
    "properties": {
      "anchor": {
        "description": "Text that appears exactly once in the post as it currently reads.",
        "type": "string"
      },
      "createdAt": {
        "description": "When this record was written (UTC).",
        "format": "datetime",
        "type": "string"
      },
      "id": {
        "description": "Name of the patch, unique on the site (lowercase letters, digits and hyphens).",
        "type": "string"
      },
      "lang": {
        "description": "Which version the patch changes: ko or en. Absent means ko.",
        "knownValues": [
          "ko",
          "en"
        ],
        "type": "string"
      },
      "op": {
        "description": "What to do at the anchor: replace it, insert text before or after it, or delete it.",
        "knownValues": [
          "replace",
          "insert-before",
          "insert-after",
          "delete"
        ],
        "type": "string"
      },
      "post": {
        "description": "Id of the post this record belongs to (the rkey of its com.guineeeeeeeeeeeeeeeeeeeeeeeerm.post record, YYYYMMDD-HHMMSS).",
        "type": "string"
      },
      "text": {
        "description": "The new text. Required for replace, insert-before and insert-after; absent for delete.",
        "type": "string"
      },
      "why": {
        "description": "Why the author made this change, in their own words.",
        "type": "string"
      }
    },
    "required": [
      "id",
      "post",
      "why",
      "op",
      "anchor",
      "createdAt"
    ],
    "type": "object"
  },
  "type": "record"
}