@inklok/api-spec 7.4.0 → 7.5.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (2) hide show
  1. package/openapi.yaml +16 -6
  2. package/package.json +1 -1
package/openapi.yaml CHANGED
@@ -8,7 +8,7 @@ info:
8
8
  Authenticate using an API key or bearer token, then use the resources below to manage
9
9
  templates, agreements, documents, and signing. For your first integration, start with
10
10
  the Quick Start guide.
11
- version: "7.4.0"
11
+ version: "7.5.1"
12
12
  contact:
13
13
  name: Inklok API Support
14
14
  email: support@inklok.com
@@ -2579,10 +2579,13 @@ paths:
2579
2579
  type: array
2580
2580
  items:
2581
2581
  type: object
2582
- required: [field_id, page, x, y, type, party_id]
2582
+ required: [field_id, label, page, x, y, type, party_id]
2583
2583
  properties:
2584
2584
  field_id:
2585
2585
  type: string
2586
+ label:
2587
+ type: string
2588
+ description: Display label copied from the source template placeholder, when provided.
2586
2589
  order:
2587
2590
  type: integer
2588
2591
  page:
@@ -4596,7 +4599,7 @@ components:
4596
4599
  description: Document identifier
4597
4600
  type:
4598
4601
  type: string
4599
- enum: [signature, text, date]
4602
+ enum: [signature, text, date, checkbox]
4600
4603
  description: Placeholder type
4601
4604
  position:
4602
4605
  type: object
@@ -4963,14 +4966,14 @@ components:
4963
4966
  description: |
4964
4967
  Field placed on a template for a participant to complete.
4965
4968
  Coordinates are normalized to the document page.
4966
- required: [id, type, role, page, x_norm, y_norm, width_norm, height_norm]
4969
+ required: [id, type, role, label, page, x_norm, y_norm, width_norm, height_norm]
4967
4970
  properties:
4968
4971
  id:
4969
4972
  type: string
4970
4973
  description: Placeholder identifier
4971
4974
  type:
4972
4975
  type: string
4973
- enum: [signature, text, date]
4976
+ enum: [signature, text, date, checkbox]
4974
4977
  description: Placeholder type
4975
4978
  role:
4976
4979
  type: string
@@ -4991,6 +4994,10 @@ components:
4991
4994
  height_norm:
4992
4995
  type: number
4993
4996
  description: Normalized height (0–1)
4997
+ label:
4998
+ type: string
4999
+ minLength: 1
5000
+ description: Display label for the placeholder
4994
5001
  required:
4995
5002
  type: boolean
4996
5003
  description: Whether the placeholder must be completed by the assigned role
@@ -5362,10 +5369,13 @@ components:
5362
5369
 
5363
5370
  ExecutionPlaceholderValue:
5364
5371
  type: object
5365
- required: [placeholderId, participantId, value, signedAt]
5372
+ required: [placeholderId, label, participantId, value, signedAt]
5366
5373
  properties:
5367
5374
  placeholderId:
5368
5375
  type: string
5376
+ label:
5377
+ type: string
5378
+ description: Display label copied from the source template placeholder, when provided.
5369
5379
  participantId:
5370
5380
  type: string
5371
5381
  value:
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@inklok/api-spec",
3
- "version": "7.4.0",
3
+ "version": "7.5.1",
4
4
  "description": "Canonical OpenAPI specification for the Inklok public API.",
5
5
  "main": "openapi.yaml",
6
6
  "license": "MIT",