Update opensign.yaml

docs/docs/API-docs/opensign.yaml

@@ -290,7 +290,7 @@ paths:
       tags:
       - Documents
       summary: Create Document
-      description: "The Create Document API allows users to generate new documents by providing data with base64 encoded file.\n\nUpload you pdf in our [**Debug UI**](https://app.opensignlabs.com/debugpdf) here you can draw widgets and copy co-oridnate, page number of them. also you can copy base64 of PDF\n\n**Below widgets are supported in the document:**\n\nCommon parameters of widgets:\n- **type:** Indicates the type of widget.\n- **page:** Specifies the page number on which you want to place the respective widget.\n- **x, y:** Denotes the horizontal and vertical coordinates of the starting point of the widget. You can use the debug UI to determine these values.\n- **w, h:** Represents the width and height of the widget. You can adjust these values using the debug UI.\n- **required:** Set to false if you want to make the widget optional. By default, it's true. Not applicable for signature-type widgets.\n- **name:** Provides a different name for widgets if you are providing more than one widget.\n1. **signature:**\n```\n{\n  \"type\":\"signature\", \n  \"page\":1,  \n  \"x\": 327, \n  \"y\": 628, \n  \"w\": 114, \n  \"h\": 21\n}\n```\n- **Note:** At least one signature is required for each signer\n2. **stamp:**\n```\n{\n  \"type\":\"stamp\", \n  \"page\":1,  \n  \"x\": 327, \n  \"y\": 628, \n  \"w\": 114, \n  \"h\": 21, \n  \"options\": {\n    \"required\": true, \n    \"name\": \"stamp\"\n  }\n}\n```\n3. **initials:**\n```\n{\n  \"type\":\"initials\", \n  \"page\":1,  \n  \"x\": 327, \n  \"y\": 628, \n  \"w\": 114, \n  \"h\": 21, \n  \"options\": {\n    \"required\": true, \n    \"name\": \"initials\"\n  }\n}\n```\n4. **email:**\n```\n{\n  \"type\":\"email\", \n  \"page\":1,  \n  \"x\": 327, \n  \"y\": 628, \n  \"w\": 114, \n  \"h\": 21, \n  \"options\": {\n    \"required\": true, \n    \"name\": \"email\"\n  }\n}\n```\n5. **name:**\n```\n{\n  \"type\":\"name\", \n  \"page\":1,  \n  \"x\": 327, \n  \"y\": 628, \n  \"w\": 114, \n  \"h\": 21, \n  \"options\": {\n    \"required\": true, \n    \"name\": \"name\"\n  }\n}\n```\n6. **job title:**\n```\n{\n  \"type\":\"job title\", \n  \"page\":1,  \n  \"x\": 327, \n  \"y\": 628, \n  \"w\": 114, \n  \"h\": 21, \n  \"options\": {\n    \"required\": true, \n    \"name\": \"job title\"\n  }\n}\n```\n7. **company:**\n```\n{\n  \"type\":\"company\", \n  \"page\":1,  \n  \"x\": 327, \n  \"y\": 628, \n  \"w\": 114, \n  \"h\": 21, \n  \"options\": {\n    \"required\": true, \n    \"name\": \"company\"\n  }\n}\n```\n8. **date:**\n```\n{\n  \"type\":\"date\", \n  \"page\":1,  \n  \"x\": 327, \n  \"y\": 628, \n  \"w\": 114, \n  \"h\": 21, \n  \"options\": {\n    \"required\": true, \n    \"name\": \"date\",\n    \"default\": \"04-15-2024\",\n    \"format\": \"mm-dd-yyyy\" \n  }\n}\n ```\n- **default:**  Provide the date from which you want to start the date of the date widget. Must be provided in the specified format. By default, today's date provided.\n- **format:** Specify the date format of your choice from the options below.\n  - \"dd/MM/yyyy\",\n  - \"dd-mm-yyyy\", \n  - \"yyyy-mm-dd\", \n  - \"mm.dd.yyyy\", \n  - \"mm-dd-yyyy\", \n  - \"mmm dd, yyyy\", \n  - \"mmmm dd, yyyy\", \n  - \"dd mmm, yyyy\", \n  - \"dd mmmm, yyy\"\n\n9. **textbox:**\n```\n{\n  \"type\":\"textbox\", \n  \"page\":1,  \n  \"x\": 327, \n  \"y\": 628, \n  \"w\": 114, \n  \"h\": 21, \n  \"options\": {\n    \"required\": true, \n    \"name\": \"textbox\",\n    \"default\": \"name\",\n    \"hint\": \"provide name\",\n    \"regularexpression\":\"\"\n  }\n}\n```\n- **default:** Provide a default value for the textbox (Optional).\n- **hint:** Provide a hint for the textbox (Optional).\n- **regularexpression:** Provide regex for custom validation, such as allowing only numbers, only capital letters, etc. (Optional).\n\n10. **checkbox:**\n```\n{\n  \"type\":\"checkbox\", \n  \"page\":1,  \n  \"x\": 327, \n  \"y\": 628, \n  \"w\": 114, \n  \"h\": 21, \n  \"options\": {\n    \"required\": true, \n    \"name\": \"checkbox\",\n    \"values\": [\"male\", \"female\", \"other\"],\n    \"selectedvalues\": [ \"male\", \"female\" ],\n    \"readonly\": false, \n    \"hidelabel\": false,\n    \"validation\": {\n      \"minselections\": 0, \n      \"maxselections\": 0 \n    }\n  }\n}\n```\n- **values:** Provide options for the checkbox list.\n- **selectedvalues:** Provide values that need to be selected by default (Optional).\n- **readonly:** Set to true if you want to set the checkbox as readonly. By default, it's false\n- **hidelabel:** Set to true if you want to hide labels of the checkbox. By default, it's false.\n- **minselections:** Provide the minimum number of checkboxes that must be selected by the user.\n- **maxselections:** Provide the maximum number of checkboxes that can be selected by the user.\n\n11. **dropdown:**\n ```\n{\n  \"type\":\"dropdown\", \n  \"page\":1,  \n  \"x\": 327, \n  \"y\": 628, \n  \"w\": 114, \n  \"h\": 21, \n  \"options\": {\n    \"required\": true, \n    \"name\": \"dropdown\",\n    \"values\": [\"male\", \"female\", \"other\"],\n    \"default\": \"male\"\n    }\n  }\n}\n```\n- **values:** Provide options for the dropdown list.\n- **default:** Provide the value that needs to be selected by default. Only one value is accepted. (Optional).\n12. **radio button:**\n```\n{\n  \"type\":\"radio button\", \n  \"page\":1,  \n  \"x\": 327, \n  \"y\": 628, \n  \"w\": 114, \n  \"h\": 21, \n  \"options\": {\n    \"required\": true, \n    \"name\": \"radio button\",\n    \"values\": [\"male\", \"female\", \"other\"],\n    \"default\": \"male\"\n    }\n  }\n}\n```  \n- **values:** Provide options for the radio button list.\n- **default:** Provide the value that needs to be selected by default. Only one value is accepted. (Optional).\n13. **image:**\n```\n{\n  \"type\":\"image\", \n  \"page\":1,  \n  \"x\": 327, \n  \"y\": 628, \n  \"w\": 114, \n  \"h\": 21, \n  \"options\": {\n    \"required\": true, \n    \"name\": \"image\"\n    }\n  }\n}\n```\n"
+      description: "The Create Document API allows users to generate new documents by providing data with base64 encoded file.\n\nUpload you pdf in our [**Debug UI**](https://app.opensignlabs.com/debugpdf) here you can draw widgets and copy co-oridnate, page number of them. also you can copy base64 of PDF\n\n**Below widgets are supported in the document:**\n\nCommon parameters of widgets:\n- **type:** Indicates the type of widget.\n- **page:** Specifies the page number on which you want to place the respective widget.\n- **x, y:** Denotes the horizontal and vertical coordinates of the starting point of the widget. You can use the debug UI to determine these values.\n- **w, h:** Represents the width and height of the widget. You can adjust these values using the debug UI.\n- **required:** Set to false if you want to make the widget optional. By default, it's true. Not applicable for signature-type widgets.\n- **name:** Provides a different name for widgets if you are providing more than one widget.\n1. **signature:**\n```\n{\n  \"type\":\"signature\", \n  \"page\":1,  \n  \"x\": 327, \n  \"y\": 628, \n  \"w\": 114, \n  \"h\": 21\n}\n```\n- **Note:** At least one signature is required for each signer. All signature fields are compulsory by default.\n2. **stamp:**\n```\n{\n  \"type\":\"stamp\", \n  \"page\":1,  \n  \"x\": 327, \n  \"y\": 628, \n  \"w\": 114, \n  \"h\": 21, \n  \"options\": {\n    \"required\": true, \n    \"name\": \"stamp\"\n  }\n}\n```\n3. **initials:**\n```\n{\n  \"type\":\"initials\", \n  \"page\":1,  \n  \"x\": 327, \n  \"y\": 628, \n  \"w\": 114, \n  \"h\": 21, \n  \"options\": {\n    \"required\": true, \n    \"name\": \"initials\"\n  }\n}\n```\n4. **email:**\n```\n{\n  \"type\":\"email\", \n  \"page\":1,  \n  \"x\": 327, \n  \"y\": 628, \n  \"w\": 114, \n  \"h\": 21, \n  \"options\": {\n    \"required\": true, \n    \"name\": \"email\"\n  }\n}\n```\n5. **name:**\n```\n{\n  \"type\":\"name\", \n  \"page\":1,  \n  \"x\": 327, \n  \"y\": 628, \n  \"w\": 114, \n  \"h\": 21, \n  \"options\": {\n    \"required\": true, \n    \"name\": \"name\"\n  }\n}\n```\n6. **job title:**\n```\n{\n  \"type\":\"job title\", \n  \"page\":1,  \n  \"x\": 327, \n  \"y\": 628, \n  \"w\": 114, \n  \"h\": 21, \n  \"options\": {\n    \"required\": true, \n    \"name\": \"job title\"\n  }\n}\n```\n7. **company:**\n```\n{\n  \"type\":\"company\", \n  \"page\":1,  \n  \"x\": 327, \n  \"y\": 628, \n  \"w\": 114, \n  \"h\": 21, \n  \"options\": {\n    \"required\": true, \n    \"name\": \"company\"\n  }\n}\n```\n8. **date:**\n```\n{\n  \"type\":\"date\", \n  \"page\":1,  \n  \"x\": 327, \n  \"y\": 628, \n  \"w\": 114, \n  \"h\": 21, \n  \"options\": {\n    \"required\": true, \n    \"name\": \"date\",\n    \"default\": \"04-15-2024\",\n    \"format\": \"mm-dd-yyyy\" \n  }\n}\n ```\n- **default:**  Provide the date from which you want to start the date of the date widget. Must be provided in the specified format. By default, today's date provided.\n- **format:** Specify the date format of your choice from the options below.\n  - \"dd/MM/yyyy\",\n  - \"dd-mm-yyyy\", \n  - \"yyyy-mm-dd\", \n  - \"mm.dd.yyyy\", \n  - \"mm-dd-yyyy\", \n  - \"mmm dd, yyyy\", \n  - \"mmmm dd, yyyy\", \n  - \"dd mmm, yyyy\", \n  - \"dd mmmm, yyy\"\n\n9. **textbox:**\n```\n{\n  \"type\":\"textbox\", \n  \"page\":1,  \n  \"x\": 327, \n  \"y\": 628, \n  \"w\": 114, \n  \"h\": 21, \n  \"options\": {\n    \"required\": true, \n    \"name\": \"textbox\",\n    \"default\": \"name\",\n    \"hint\": \"provide name\",\n    \"regularexpression\":\"\"\n  }\n}\n```\n- **default:** Provide a default value for the textbox (Optional).\n- **hint:** Provide a hint for the textbox (Optional).\n- **regularexpression:** Provide regex for custom validation, such as allowing only numbers, only capital letters, etc. (Optional).\n\n10. **checkbox:**\n```\n{\n  \"type\":\"checkbox\", \n  \"page\":1,  \n  \"x\": 327, \n  \"y\": 628, \n  \"w\": 114, \n  \"h\": 21, \n  \"options\": {\n    \"required\": true, \n    \"name\": \"checkbox\",\n    \"values\": [\"male\", \"female\", \"other\"],\n    \"selectedvalues\": [ \"male\", \"female\" ],\n    \"readonly\": false, \n    \"hidelabel\": false,\n    \"validation\": {\n      \"minselections\": 0, \n      \"maxselections\": 0 \n    }\n  }\n}\n```\n- **values:** Provide options for the checkbox list.\n- **selectedvalues:** Provide values that need to be selected by default (Optional).\n- **readonly:** Set to true if you want to set the checkbox as readonly. By default, it's false\n- **hidelabel:** Set to true if you want to hide labels of the checkbox. By default, it's false.\n- **minselections:** Provide the minimum number of checkboxes that must be selected by the user.\n- **maxselections:** Provide the maximum number of checkboxes that can be selected by the user.\n\n11. **dropdown:**\n ```\n{\n  \"type\":\"dropdown\", \n  \"page\":1,  \n  \"x\": 327, \n  \"y\": 628, \n  \"w\": 114, \n  \"h\": 21, \n  \"options\": {\n    \"required\": true, \n    \"name\": \"dropdown\",\n    \"values\": [\"male\", \"female\", \"other\"],\n    \"default\": \"male\"\n    }\n  }\n}\n```\n- **values:** Provide options for the dropdown list.\n- **default:** Provide the value that needs to be selected by default. Only one value is accepted. (Optional).\n12. **radio button:**\n```\n{\n  \"type\":\"radio button\", \n  \"page\":1,  \n  \"x\": 327, \n  \"y\": 628, \n  \"w\": 114, \n  \"h\": 21, \n  \"options\": {\n    \"required\": true, \n    \"name\": \"radio button\",\n    \"values\": [\"male\", \"female\", \"other\"],\n    \"default\": \"male\"\n    }\n  }\n}\n```  \n- **values:** Provide options for the radio button list.\n- **default:** Provide the value that needs to be selected by default. Only one value is accepted. (Optional).\n13. **image:**\n```\n{\n  \"type\":\"image\", \n  \"page\":1,  \n  \"x\": 327, \n  \"y\": 628, \n  \"w\": 114, \n  \"h\": 21, \n  \"options\": {\n    \"required\": true, \n    \"name\": \"image\"\n    }\n  }\n}\n```\n"
       operationId: createdocument
       requestBody:
         content: