@inklok/api-spec 7.2.1 → 7.2.2

package/openapi.yaml

@@ -8,7 +8,7 @@ info:
     Authenticate using an API key or bearer token, then use the resources below to manage
     templates, agreements, documents, and signing. For your first integration, start with
     the Quick Start guide.
-  version: "7.2.1"
+  version: "7.2.2"
   contact:
     name: Inklok API Support
     email: support@inklok.com
@@ -2480,6 +2480,18 @@ paths:
                 properties:
                   execution_id:
                     type: string
+                  agreement_title:
+                    type: string
+                    nullable: true
+                    description: Human-readable title for this agreement.
+                  agreement_message:
+                    type: string
+                    nullable: true
+                    description: Shared message from the sender for all recipients.
+                  recipient_message:
+                    type: string
+                    nullable: true
+                    description: Private message for the authenticated signer only.
                   version:
                     type: string
                     description: Rendering engine version for this agreement
@@ -4694,11 +4706,26 @@ components:
         name:
           type: string
           nullable: true
+        recipientMessage:
+          type: string
+          nullable: true
+          maxLength: 5000
+          description: Optional private message visible only to this recipient.
 
     CreateExecutionRequest:
       type: object
-      required: [participants, crypto]
+      required: [agreementTitle, participants, crypto]
       properties:
+        agreementTitle:
+          type: string
+          minLength: 1
+          maxLength: 160
+          description: Human-readable title for this agreement.
+        agreementMessage:
+          type: string
+          nullable: true
+          maxLength: 5000
+          description: Optional shared message visible to all recipients.
         participants:
           type: array
           minItems: 1
@@ -5047,6 +5074,16 @@ components:
           type: integer
           minimum: 1
           readOnly: true
+        agreementTitle:
+          type: string
+          nullable: true
+          readOnly: true
+          description: Human-readable title for this agreement.
+        agreementMessage:
+          type: string
+          nullable: true
+          readOnly: true
+          description: Shared message from the sender for all recipients.
         pdfEngineVersion:
           type: integer
           minimum: 1
@@ -5092,6 +5129,7 @@ components:
           createdAt,
           updatedAt,
           pdfEngineVersion,
+          agreementTitle,
           participants,
           placeholderValues,
         ]
@@ -5107,6 +5145,16 @@ components:
         status:
           $ref: '#/components/schemas/ExecutionStatus'
           readOnly: true
+        agreementTitle:
+          type: string
+          nullable: true
+          readOnly: true
+          description: Human-readable title for this agreement.
+        agreementMessage:
+          type: string
+          nullable: true
+          readOnly: true
+          description: Shared message from the sender for all recipients.
         createdAt:
           type: string
           format: date-time
@@ -5173,6 +5221,10 @@ components:
         color:
           type: string
           nullable: true
+        recipientMessage:
+          type: string
+          nullable: true
+          description: Private message for this recipient. Signer-scoped responses only include the current signer's message.
 
     ExecutionParticipantSearchResult:
       type: object

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@inklok/api-spec",
-  "version": "7.2.1",
+  "version": "7.2.2",
   "description": "Canonical OpenAPI specification for the Inklok public API.",
   "main": "openapi.yaml",
   "license": "MIT",