From e4ee24dace620629327461c00e505ea6a74fc199 Mon Sep 17 00:00:00 2001
From: Ivan Kuchin <i.kuchin@openproject.com>
Date: Thu, 26 Feb 2026 19:57:28 +0100
Subject: [PATCH] add custom comment schema

---
 .../components/schemas/custom_comment_properties.yml | 12 ++++++++++++
 docs/api/apiv3/openapi-spec.yml                      |  2 ++
 2 files changed, 14 insertions(+)
 create mode 100644 docs/api/apiv3/components/schemas/custom_comment_properties.yml

diff --git a/docs/api/apiv3/components/schemas/custom_comment_properties.yml b/docs/api/apiv3/components/schemas/custom_comment_properties.yml
new file mode 100644
index 00000000000..bcf63a2e128
--- /dev/null
+++ b/docs/api/apiv3/components/schemas/custom_comment_properties.yml
@@ -0,0 +1,12 @@
+# Schema: CustomCommentProperties
+---
+type: object
+patternProperties:
+  "^customComment\\d+$":
+    type:
+      - "null"
+      - string
+    description: |-
+      A plain-text comment associated with a project custom field that has comments enabled.
+
+      The property is only present when the corresponding `customField{N}` has `has_comment` set to `true`.
diff --git a/docs/api/apiv3/openapi-spec.yml b/docs/api/apiv3/openapi-spec.yml
index 491b53602d7..0ec085c9124 100644
--- a/docs/api/apiv3/openapi-spec.yml
+++ b/docs/api/apiv3/openapi-spec.yml
@@ -749,6 +749,8 @@ components:
       "$ref": "./components/schemas/project_configuration_model.yml"
     CustomActionModel:
       "$ref": "./components/schemas/custom_action_model.yml"
+    CustomCommentProperties:
+      "$ref": "./components/schemas/custom_comment_properties.yml"
     CustomFieldLinkedProperties:
       "$ref": "./components/schemas/custom_field_linked_properties.yml"
     CustomFieldProperties: