Skip to content

Commit cb4eb62

Browse files
vitormattosvitormattos
committed
chore: update documentation
Signed-off-by: Vitor Mattos <[email protected]>
1 parent 96fa5fe commit cb4eb62

5 files changed

Lines changed: 113 additions & 95 deletions

File tree

‎lib/ResponseDefinitions.php‎

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -199,6 +199,11 @@
199199
* status: int,
200200
* statusText: string,
201201
* }
202+
* @psalm-type LibresignValidateMetadata = array{
203+
* extension: string,
204+
* p: int,
205+
* d?: list<array{w: float, h: float}>,
206+
* }
202207
* @psalm-type LibresignEnvelopeChildFile = array{
203208
* id: int,
204209
* uuid: string,
@@ -207,6 +212,7 @@
207212
* statusText: string,
208213
* nodeId: int,
209214
* signers: list<LibresignEnvelopeChildSignerSummary>,
215+
* metadata?: LibresignValidateMetadata,
210216
* }
211217
* @psalm-type LibresignValidateFile = array{
212218
* uuid: string,
@@ -229,11 +235,7 @@
229235
* },
230236
* file: string,
231237
* url?: string,
232-
* metadata?: array{
233-
* extension: string,
234-
* p: int,
235-
* d?: list<array{w: float, h: float}>,
236-
* },
238+
* metadata?: LibresignValidateMetadata,
237239
* signers?: LibresignSigner[],
238240
* settings?: LibresignSettings,
239241
* messages?: array{

‎openapi-full.json‎

Lines changed: 40 additions & 34 deletions
Original file line numberDiff line numberDiff line change
@@ -290,6 +290,9 @@
290290
"items": {
291291
"$ref": "#/components/schemas/EnvelopeChildSignerSummary"
292292
}
293+
},
294+
"metadata": {
295+
"$ref": "#/components/schemas/ValidateMetadata"
293296
}
294297
}
295298
},
@@ -1263,40 +1266,7 @@
12631266
"type": "string"
12641267
},
12651268
"metadata": {
1266-
"type": "object",
1267-
"required": [
1268-
"extension",
1269-
"p"
1270-
],
1271-
"properties": {
1272-
"extension": {
1273-
"type": "string"
1274-
},
1275-
"p": {
1276-
"type": "integer",
1277-
"format": "int64"
1278-
},
1279-
"d": {
1280-
"type": "array",
1281-
"items": {
1282-
"type": "object",
1283-
"required": [
1284-
"w",
1285-
"h"
1286-
],
1287-
"properties": {
1288-
"w": {
1289-
"type": "number",
1290-
"format": "double"
1291-
},
1292-
"h": {
1293-
"type": "number",
1294-
"format": "double"
1295-
}
1296-
}
1297-
}
1298-
}
1299-
}
1269+
"$ref": "#/components/schemas/ValidateMetadata"
13001270
},
13011271
"signers": {
13021272
"type": "array",
@@ -1336,6 +1306,42 @@
13361306
}
13371307
}
13381308
},
1309+
"ValidateMetadata": {
1310+
"type": "object",
1311+
"required": [
1312+
"extension",
1313+
"p"
1314+
],
1315+
"properties": {
1316+
"extension": {
1317+
"type": "string"
1318+
},
1319+
"p": {
1320+
"type": "integer",
1321+
"format": "int64"
1322+
},
1323+
"d": {
1324+
"type": "array",
1325+
"items": {
1326+
"type": "object",
1327+
"required": [
1328+
"w",
1329+
"h"
1330+
],
1331+
"properties": {
1332+
"w": {
1333+
"type": "number",
1334+
"format": "double"
1335+
},
1336+
"h": {
1337+
"type": "number",
1338+
"format": "double"
1339+
}
1340+
}
1341+
}
1342+
}
1343+
}
1344+
},
13391345
"VisibleElement": {
13401346
"type": "object",
13411347
"required": [

‎openapi.json‎

Lines changed: 40 additions & 34 deletions
Original file line numberDiff line numberDiff line change
@@ -220,6 +220,9 @@
220220
"items": {
221221
"$ref": "#/components/schemas/EnvelopeChildSignerSummary"
222222
}
223+
},
224+
"metadata": {
225+
"$ref": "#/components/schemas/ValidateMetadata"
223226
}
224227
}
225228
},
@@ -1113,40 +1116,7 @@
11131116
"type": "string"
11141117
},
11151118
"metadata": {
1116-
"type": "object",
1117-
"required": [
1118-
"extension",
1119-
"p"
1120-
],
1121-
"properties": {
1122-
"extension": {
1123-
"type": "string"
1124-
},
1125-
"p": {
1126-
"type": "integer",
1127-
"format": "int64"
1128-
},
1129-
"d": {
1130-
"type": "array",
1131-
"items": {
1132-
"type": "object",
1133-
"required": [
1134-
"w",
1135-
"h"
1136-
],
1137-
"properties": {
1138-
"w": {
1139-
"type": "number",
1140-
"format": "double"
1141-
},
1142-
"h": {
1143-
"type": "number",
1144-
"format": "double"
1145-
}
1146-
}
1147-
}
1148-
}
1149-
}
1119+
"$ref": "#/components/schemas/ValidateMetadata"
11501120
},
11511121
"signers": {
11521122
"type": "array",
@@ -1186,6 +1156,42 @@
11861156
}
11871157
}
11881158
},
1159+
"ValidateMetadata": {
1160+
"type": "object",
1161+
"required": [
1162+
"extension",
1163+
"p"
1164+
],
1165+
"properties": {
1166+
"extension": {
1167+
"type": "string"
1168+
},
1169+
"p": {
1170+
"type": "integer",
1171+
"format": "int64"
1172+
},
1173+
"d": {
1174+
"type": "array",
1175+
"items": {
1176+
"type": "object",
1177+
"required": [
1178+
"w",
1179+
"h"
1180+
],
1181+
"properties": {
1182+
"w": {
1183+
"type": "number",
1184+
"format": "double"
1185+
},
1186+
"h": {
1187+
"type": "number",
1188+
"format": "double"
1189+
}
1190+
}
1191+
}
1192+
}
1193+
}
1194+
},
11891195
"VisibleElement": {
11901196
"type": "object",
11911197
"required": [

‎src/types/openapi/openapi-full.ts‎

Lines changed: 13 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1542,6 +1542,7 @@ export type components = {
15421542
/** Format: int64 */
15431543
nodeId: number;
15441544
signers: components["schemas"]["EnvelopeChildSignerSummary"][];
1545+
metadata?: components["schemas"]["ValidateMetadata"];
15451546
};
15461547
EnvelopeChildSignerSummary: {
15471548
/** Format: int64 */
@@ -1827,17 +1828,7 @@ export type components = {
18271828
};
18281829
file: string;
18291830
url?: string;
1830-
metadata?: {
1831-
extension: string;
1832-
/** Format: int64 */
1833-
p: number;
1834-
d?: {
1835-
/** Format: double */
1836-
w: number;
1837-
/** Format: double */
1838-
h: number;
1839-
}[];
1840-
};
1831+
metadata?: components["schemas"]["ValidateMetadata"];
18411832
signers?: components["schemas"]["Signer"][];
18421833
settings?: components["schemas"]["Settings"];
18431834
messages?: {
@@ -1847,6 +1838,17 @@ export type components = {
18471838
}[];
18481839
visibleElements?: components["schemas"]["VisibleElement"][];
18491840
};
1841+
ValidateMetadata: {
1842+
extension: string;
1843+
/** Format: int64 */
1844+
p: number;
1845+
d?: {
1846+
/** Format: double */
1847+
w: number;
1848+
/** Format: double */
1849+
h: number;
1850+
}[];
1851+
};
18501852
VisibleElement: {
18511853
/** Format: int64 */
18521854
elementId: number;

‎src/types/openapi/openapi.ts‎

Lines changed: 13 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1086,6 +1086,7 @@ export type components = {
10861086
/** Format: int64 */
10871087
nodeId: number;
10881088
signers: components["schemas"]["EnvelopeChildSignerSummary"][];
1089+
metadata?: components["schemas"]["ValidateMetadata"];
10891090
};
10901091
EnvelopeChildSignerSummary: {
10911092
/** Format: int64 */
@@ -1349,17 +1350,7 @@ export type components = {
13491350
};
13501351
file: string;
13511352
url?: string;
1352-
metadata?: {
1353-
extension: string;
1354-
/** Format: int64 */
1355-
p: number;
1356-
d?: {
1357-
/** Format: double */
1358-
w: number;
1359-
/** Format: double */
1360-
h: number;
1361-
}[];
1362-
};
1353+
metadata?: components["schemas"]["ValidateMetadata"];
13631354
signers?: components["schemas"]["Signer"][];
13641355
settings?: components["schemas"]["Settings"];
13651356
messages?: {
@@ -1369,6 +1360,17 @@ export type components = {
13691360
}[];
13701361
visibleElements?: components["schemas"]["VisibleElement"][];
13711362
};
1363+
ValidateMetadata: {
1364+
extension: string;
1365+
/** Format: int64 */
1366+
p: number;
1367+
d?: {
1368+
/** Format: double */
1369+
w: number;
1370+
/** Format: double */
1371+
h: number;
1372+
}[];
1373+
};
13721374
VisibleElement: {
13731375
/** Format: int64 */
13741376
elementId: number;

0 commit comments

Comments
 (0)