Skip to content

Commit bcc0a2a

Browse files
vitormattosvitormattos
committed
fix: update documentation
Signed-off-by: Vitor Mattos <1079143+vitormattos@users.noreply.github.com>
1 parent 33b7180 commit bcc0a2a

File tree

4 files changed

+238
-196
lines changed

4 files changed

+238
-196
lines changed

‎openapi-full.json‎

Lines changed: 90 additions & 53 deletions
Original file line numberDiff line numberDiff line change
@@ -252,6 +252,81 @@
252252
}
253253
}
254254
},
255+
"EnvelopeChildFile": {
256+
"type": "object",
257+
"required": [
258+
"id",
259+
"uuid",
260+
"name",
261+
"status",
262+
"statusText",
263+
"nodeId",
264+
"signers"
265+
],
266+
"properties": {
267+
"id": {
268+
"type": "integer",
269+
"format": "int64"
270+
},
271+
"uuid": {
272+
"type": "string"
273+
},
274+
"name": {
275+
"type": "string"
276+
},
277+
"status": {
278+
"type": "integer",
279+
"format": "int64"
280+
},
281+
"statusText": {
282+
"type": "string"
283+
},
284+
"nodeId": {
285+
"type": "integer",
286+
"format": "int64"
287+
},
288+
"signers": {
289+
"type": "array",
290+
"items": {
291+
"$ref": "#/components/schemas/EnvelopeChildSignerSummary"
292+
}
293+
}
294+
}
295+
},
296+
"EnvelopeChildSignerSummary": {
297+
"type": "object",
298+
"required": [
299+
"signRequestId",
300+
"displayName",
301+
"email",
302+
"signed",
303+
"status",
304+
"statusText"
305+
],
306+
"properties": {
307+
"signRequestId": {
308+
"type": "integer",
309+
"format": "int64"
310+
},
311+
"displayName": {
312+
"type": "string"
313+
},
314+
"email": {
315+
"type": "string"
316+
},
317+
"signed": {
318+
"type": "string",
319+
"nullable": true
320+
},
321+
"status": {
322+
"type": "integer",
323+
"format": "int64"
324+
},
325+
"statusText": {
326+
"type": "string"
327+
}
328+
}
329+
},
255330
"File": {
256331
"type": "object",
257332
"required": [
@@ -1136,6 +1211,17 @@
11361211
"type": "integer",
11371212
"format": "int64"
11381213
},
1214+
"filesCount": {
1215+
"type": "integer",
1216+
"format": "int64",
1217+
"minimum": 0
1218+
},
1219+
"files": {
1220+
"type": "array",
1221+
"items": {
1222+
"$ref": "#/components/schemas/EnvelopeChildFile"
1223+
}
1224+
},
11391225
"totalPages": {
11401226
"type": "integer",
11411227
"format": "int64",
@@ -1925,55 +2011,6 @@
19252011
}
19262012
}
19272013
},
1928-
"/index.php/apps/libresign/p/id-docs/approve/{uuid}/{path}": {
1929-
"get": {
1930-
"operationId": "page-sign-id-doc-private",
1931-
"summary": "Show signature page for identification document approval",
1932-
"tags": [
1933-
"page"
1934-
],
1935-
"security": [
1936-
{
1937-
"bearer_auth": []
1938-
},
1939-
{
1940-
"basic_auth": []
1941-
}
1942-
],
1943-
"parameters": [
1944-
{
1945-
"name": "uuid",
1946-
"in": "path",
1947-
"description": "File UUID for the identification document approval",
1948-
"required": true,
1949-
"schema": {
1950-
"type": "string"
1951-
}
1952-
},
1953-
{
1954-
"name": "path",
1955-
"in": "path",
1956-
"required": true,
1957-
"schema": {
1958-
"type": "string",
1959-
"pattern": "^.+$"
1960-
}
1961-
}
1962-
],
1963-
"responses": {
1964-
"200": {
1965-
"description": "OK",
1966-
"content": {
1967-
"text/html": {
1968-
"schema": {
1969-
"type": "string"
1970-
}
1971-
}
1972-
}
1973-
}
1974-
}
1975-
}
1976-
},
19772014
"/index.php/apps/libresign/p/pdf/{uuid}": {
19782015
"get": {
19792016
"operationId": "page-get-pdf",
@@ -3554,7 +3591,7 @@
35543591
"get": {
35553592
"operationId": "file-validate-uuid",
35563593
"summary": "Validate a file using Uuid",
3557-
"description": "Validate a file returning file data.",
3594+
"description": "Validate a file returning file data. When `nodeType` is `envelope`, the response includes `filesCount` and `files` as a list of envelope child files.",
35583595
"tags": [
35593596
"file"
35603597
],
@@ -3713,7 +3750,7 @@
37133750
"get": {
37143751
"operationId": "file-validate-file-id",
37153752
"summary": "Validate a file using FileId",
3716-
"description": "Validate a file returning file data.",
3753+
"description": "Validate a file returning file data. When `nodeType` is `envelope`, the response includes `filesCount` and `files` as a list of envelope child files.",
37173754
"tags": [
37183755
"file"
37193756
],
@@ -3873,7 +3910,7 @@
38733910
"post": {
38743911
"operationId": "file-validate-binary",
38753912
"summary": "Validate a binary file",
3876-
"description": "Validate a binary file returning file data. Use field 'file' for the file upload",
3913+
"description": "Validate a binary file returning file data. Use field 'file' for the file upload. When `nodeType` is `envelope`, the response includes `filesCount` and `files` as a list of envelope child files.",
38773914
"tags": [
38783915
"file"
38793916
],
@@ -6748,7 +6785,7 @@
67486785
"post": {
67496786
"operationId": "request_signature-request",
67506787
"summary": "Request signature",
6751-
"description": "Request that a file be signed by a group of people. Each user in the users array can optionally include a 'signing_order' field to control the order of signatures when ordered signing flow is enabled.",
6788+
"description": "Request that a file be signed by a group of people. Each user in the users array can optionally include a 'signing_order' field to control the order of signatures when ordered signing flow is enabled. When the created entity is an envelope (`nodeType` = `envelope`), the returned `data` includes `filesCount` and `files` as a list of envelope child files.",
67526789
"tags": [
67536790
"request_signature"
67546791
],

‎openapi.json‎

Lines changed: 90 additions & 53 deletions
Original file line numberDiff line numberDiff line change
@@ -182,6 +182,81 @@
182182
}
183183
}
184184
},
185+
"EnvelopeChildFile": {
186+
"type": "object",
187+
"required": [
188+
"id",
189+
"uuid",
190+
"name",
191+
"status",
192+
"statusText",
193+
"nodeId",
194+
"signers"
195+
],
196+
"properties": {
197+
"id": {
198+
"type": "integer",
199+
"format": "int64"
200+
},
201+
"uuid": {
202+
"type": "string"
203+
},
204+
"name": {
205+
"type": "string"
206+
},
207+
"status": {
208+
"type": "integer",
209+
"format": "int64"
210+
},
211+
"statusText": {
212+
"type": "string"
213+
},
214+
"nodeId": {
215+
"type": "integer",
216+
"format": "int64"
217+
},
218+
"signers": {
219+
"type": "array",
220+
"items": {
221+
"$ref": "#/components/schemas/EnvelopeChildSignerSummary"
222+
}
223+
}
224+
}
225+
},
226+
"EnvelopeChildSignerSummary": {
227+
"type": "object",
228+
"required": [
229+
"signRequestId",
230+
"displayName",
231+
"email",
232+
"signed",
233+
"status",
234+
"statusText"
235+
],
236+
"properties": {
237+
"signRequestId": {
238+
"type": "integer",
239+
"format": "int64"
240+
},
241+
"displayName": {
242+
"type": "string"
243+
},
244+
"email": {
245+
"type": "string"
246+
},
247+
"signed": {
248+
"type": "string",
249+
"nullable": true
250+
},
251+
"status": {
252+
"type": "integer",
253+
"format": "int64"
254+
},
255+
"statusText": {
256+
"type": "string"
257+
}
258+
}
259+
},
185260
"File": {
186261
"type": "object",
187262
"required": [
@@ -986,6 +1061,17 @@
9861061
"type": "integer",
9871062
"format": "int64"
9881063
},
1064+
"filesCount": {
1065+
"type": "integer",
1066+
"format": "int64",
1067+
"minimum": 0
1068+
},
1069+
"files": {
1070+
"type": "array",
1071+
"items": {
1072+
"$ref": "#/components/schemas/EnvelopeChildFile"
1073+
}
1074+
},
9891075
"totalPages": {
9901076
"type": "integer",
9911077
"format": "int64",
@@ -1775,55 +1861,6 @@
17751861
}
17761862
}
17771863
},
1778-
"/index.php/apps/libresign/p/id-docs/approve/{uuid}/{path}": {
1779-
"get": {
1780-
"operationId": "page-sign-id-doc-private",
1781-
"summary": "Show signature page for identification document approval",
1782-
"tags": [
1783-
"page"
1784-
],
1785-
"security": [
1786-
{
1787-
"bearer_auth": []
1788-
},
1789-
{
1790-
"basic_auth": []
1791-
}
1792-
],
1793-
"parameters": [
1794-
{
1795-
"name": "uuid",
1796-
"in": "path",
1797-
"description": "File UUID for the identification document approval",
1798-
"required": true,
1799-
"schema": {
1800-
"type": "string"
1801-
}
1802-
},
1803-
{
1804-
"name": "path",
1805-
"in": "path",
1806-
"required": true,
1807-
"schema": {
1808-
"type": "string",
1809-
"pattern": "^.+$"
1810-
}
1811-
}
1812-
],
1813-
"responses": {
1814-
"200": {
1815-
"description": "OK",
1816-
"content": {
1817-
"text/html": {
1818-
"schema": {
1819-
"type": "string"
1820-
}
1821-
}
1822-
}
1823-
}
1824-
}
1825-
}
1826-
},
18271864
"/index.php/apps/libresign/p/pdf/{uuid}": {
18281865
"get": {
18291866
"operationId": "page-get-pdf",
@@ -3404,7 +3441,7 @@
34043441
"get": {
34053442
"operationId": "file-validate-uuid",
34063443
"summary": "Validate a file using Uuid",
3407-
"description": "Validate a file returning file data.",
3444+
"description": "Validate a file returning file data. When `nodeType` is `envelope`, the response includes `filesCount` and `files` as a list of envelope child files.",
34083445
"tags": [
34093446
"file"
34103447
],
@@ -3563,7 +3600,7 @@
35633600
"get": {
35643601
"operationId": "file-validate-file-id",
35653602
"summary": "Validate a file using FileId",
3566-
"description": "Validate a file returning file data.",
3603+
"description": "Validate a file returning file data. When `nodeType` is `envelope`, the response includes `filesCount` and `files` as a list of envelope child files.",
35673604
"tags": [
35683605
"file"
35693606
],
@@ -3723,7 +3760,7 @@
37233760
"post": {
37243761
"operationId": "file-validate-binary",
37253762
"summary": "Validate a binary file",
3726-
"description": "Validate a binary file returning file data. Use field 'file' for the file upload",
3763+
"description": "Validate a binary file returning file data. Use field 'file' for the file upload. When `nodeType` is `envelope`, the response includes `filesCount` and `files` as a list of envelope child files.",
37273764
"tags": [
37283765
"file"
37293766
],
@@ -6598,7 +6635,7 @@
65986635
"post": {
65996636
"operationId": "request_signature-request",
66006637
"summary": "Request signature",
6601-
"description": "Request that a file be signed by a group of people. Each user in the users array can optionally include a 'signing_order' field to control the order of signatures when ordered signing flow is enabled.",
6638+
"description": "Request that a file be signed by a group of people. Each user in the users array can optionally include a 'signing_order' field to control the order of signatures when ordered signing flow is enabled. When the created entity is an envelope (`nodeType` = `envelope`), the returned `data` includes `filesCount` and `files` as a list of envelope child files.",
66026639
"tags": [
66036640
"request_signature"
66046641
],

0 commit comments

Comments
 (0)