Skip to content

Commit 3d91b8b

Browse files
prafull-opensignlabsprafull-opensignlabs
authored
Enhance 'cells' widget documentation in opensign.yaml
Added detailed specifications for 'cells' widget including options like 'cell_count', 'default', and 'hint'. Updated multiple sections to ensure consistency in widget definitions.
1 parent 592f35f commit 3d91b8b

File tree

1 file changed

+163
-3
lines changed

1 file changed

+163
-3
lines changed

‎docs/docs/API-docs/v1.1/opensign.yaml‎

Lines changed: 163 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -594,6 +594,31 @@ paths:
594594
- **formula:** Compute the value from other number widgets using +, -, *, /, (, ). Reference widgets by their name in double curly braces, e.g. {{quantity}} * {{rate}}. to know more [visit here](https://docs.opensignlabs.com/docs/help/New-Document/widgets) (optional).
595595
- **default:** Provide a default number (Optional).
596596
- **decimalplaces:** Number of digits to display after the decimal point. e.g: 2 => 12.00, 0 => 12 (default 2)
597+
598+
13. **cells**
599+
```
600+
{
601+
"type": "cells",
602+
"page": 1,
603+
"x": 100,
604+
"y": 100,
605+
"w": 114,
606+
"h": 50,
607+
"options": {
608+
"name": "cells",
609+
"required": true,
610+
"readonly": false,
611+
"cell_count": 5,
612+
"default": "",
613+
"hint": "",
614+
"regularexpression": "",
615+
"color": "black",
616+
"fontsize": 12,
617+
"hide_text_with_asterisks": false
618+
}
619+
}
620+
```
621+
- **cell_count:** Specify the number of cells that should be returned to the user.
597622
operationId: selfsign
598623
requestBody:
599624
content:
@@ -955,6 +980,31 @@ paths:
955980
- **readonly:** Set to true if you want to set the textbox as readonly. By default, it's false.
956981
- **decimalplaces:** Number of digits to display after the decimal point. e.g: 2 => 12.00, 0 => 12 (default 2)
957982
983+
15. **cells**
984+
```
985+
{
986+
"type": "cells",
987+
"page": 1,
988+
"x": 100,
989+
"y": 100,
990+
"w": 114,
991+
"h": 50,
992+
"options": {
993+
"name": "cells",
994+
"required": true,
995+
"readonly": false,
996+
"cell_count": 5,
997+
"default": "",
998+
"hint": "",
999+
"regularexpression": "",
1000+
"color": "black",
1001+
"fontsize": 12,
1002+
"hide_text_with_asterisks": false
1003+
}
1004+
}
1005+
```
1006+
- **cell_count:** Specify the number of cells that should be returned to the user.
1007+
9581008
**Prefill Widgets:** Prefill widgets are elements that are inserted into a document **before** it is shared with a user. Only the document creator has permission to add them.
9591009
9601010
**Note:** Responses for prefill widgets are **required**.
@@ -1438,7 +1488,32 @@ paths:
14381488
- **hint:** Provide a hint for the number (Optional).
14391489
- **readonly:** Set to true if you want to set the textbox as readonly. By default, it's false.
14401490
- **decimalplaces:** Number of digits to display after the decimal point. e.g: 2 => 12.00, 0 => 12 (default 2)
1441-
1491+
1492+
15. **cells**
1493+
```
1494+
{
1495+
"type": "cells",
1496+
"page": 1,
1497+
"x": 100,
1498+
"y": 100,
1499+
"w": 114,
1500+
"h": 50,
1501+
"options": {
1502+
"name": "cells",
1503+
"required": true,
1504+
"readonly": false,
1505+
"cell_count": 5,
1506+
"default": "",
1507+
"hint": "",
1508+
"regularexpression": "",
1509+
"color": "black",
1510+
"fontsize": 12,
1511+
"hide_text_with_asterisks": false
1512+
}
1513+
}
1514+
```
1515+
- **cell_count:** Specify the number of cells that should be returned to the user.
1516+
14421517
**Prefill Widgets:** Prefill widgets are elements that are inserted into a document **before** it is shared with a user. Only the document creator has permission to add them.
14431518

14441519
**Note:** Responses for prefill widgets are **required**.
@@ -1704,6 +1779,18 @@ paths:
17041779
17051780
**Prefill Widgets:** Prefill widgets are elements that are inserted into a document before it is shared with a user. Only the document creator has permission to add them.
17061781
1782+
11. **cells**
1783+
```
1784+
{
1785+
"name": "cells",
1786+
"readonly": false,
1787+
"cell_count": 5,
1788+
"default": "",
1789+
"hide_text_with_asterisks": false
1790+
}
1791+
```
1792+
- **cell_count:** Specify the number of cells that should be returned to the user.
1793+
17071794
**response:** Provide the value that should replace the existing response.
17081795
17091796
**List of widgets supported in Prefill**
@@ -2554,7 +2641,31 @@ paths:
25542641
- **readonly:** Set to true if you want to set the textbox as readonly. By default, it's false.
25552642
- **decimalplaces:** Number of digits to display after the decimal point. e.g: 2 => 12.00, 0 => 12 (default 2)
25562643
2557-
2644+
15. **cells**
2645+
```
2646+
{
2647+
"type": "cells",
2648+
"page": 1,
2649+
"x": 100,
2650+
"y": 100,
2651+
"w": 114,
2652+
"h": 50,
2653+
"options": {
2654+
"name": "cells",
2655+
"required": true,
2656+
"readonly": false,
2657+
"cell_count": 5,
2658+
"default": "",
2659+
"hint": "",
2660+
"regularexpression": "",
2661+
"color": "black",
2662+
"fontsize": 12,
2663+
"hide_text_with_asterisks": false
2664+
}
2665+
}
2666+
```
2667+
- **cell_count:** Specify the number of cells that should be returned to the user.
2668+
25582669
**Prefill Widgets:** Prefill widgets are elements that are inserted into a document **before** it is shared with a user. Only the document creator has permission to add them.
25592670
25602671
**Note:** Responses for prefill widgets are **required**.
@@ -3060,7 +3171,32 @@ paths:
30603171
- **readonly:** Set to true if you want to set the textbox as readonly. By default, it's false.
30613172
- **decimalplaces:** Number of digits to display after the decimal point. e.g: 2 => 12.00, 0 => 12 (default 2)
30623173
3063-
3174+
15. **cells**
3175+
```
3176+
{
3177+
"type": "cells",
3178+
"page": 1,
3179+
"x": 100,
3180+
"y": 100,
3181+
"w": 114,
3182+
"h": 50,
3183+
"options": {
3184+
"name": "cells",
3185+
"required": true,
3186+
"readonly": false,
3187+
"cell_count": 5,
3188+
"default": "",
3189+
"hint": "",
3190+
"regularexpression": "",
3191+
"color": "black",
3192+
"fontsize": 12,
3193+
"hide_text_with_asterisks": false
3194+
}
3195+
}
3196+
```
3197+
- **cell_count:** Specify the number of cells that should be returned to the user.
3198+
3199+
30643200
**Prefill Widgets:** Prefill widgets are elements that are inserted into a document **before** it is shared with a user. Only the document creator has permission to add them.
30653201

30663202
**Note:** Responses for prefill widgets are **required**.
@@ -3565,6 +3701,30 @@ paths:
35653701
- **readonly:** Set to true if you want to set the textbox as readonly. By default, it's false.
35663702
- **decimalplaces:** Number of digits to display after the decimal point. e.g: 2 => 12.00, 0 => 12 (default 2)
35673703
3704+
15. **cells**
3705+
```
3706+
{
3707+
"type": "cells",
3708+
"page": 1,
3709+
"x": 100,
3710+
"y": 100,
3711+
"w": 114,
3712+
"h": 50,
3713+
"options": {
3714+
"name": "cells",
3715+
"required": true,
3716+
"readonly": false,
3717+
"cell_count": 5,
3718+
"default": "",
3719+
"hint": "",
3720+
"regularexpression": "",
3721+
"color": "black",
3722+
"fontsize": 12,
3723+
"hide_text_with_asterisks": false
3724+
}
3725+
}
3726+
```
3727+
- **cell_count:** Specify the number of cells that should be returned to the user.
35683728
35693729
**Prefill Widgets:** Prefill widgets are elements that are inserted into a document **before** it is shared with a user. Only the document creator has permission to add them.
35703730

0 commit comments

Comments
 (0)