Skip to content

Commit 43804d3

Browse files
vitormattosvitormattos
committed
chore: update OpenAPI specs and TypeScript types
- Update openapi.json with new signature-flow endpoint - Regenerate TypeScript types from OpenAPI specs - Auto-generated by openapi-extractor Signed-off-by: Vitor Mattos <[email protected]>
1 parent 867f89f commit 43804d3

6 files changed

Lines changed: 436 additions & 8 deletions

File tree

‎openapi-administration.json‎

Lines changed: 139 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -998,6 +998,145 @@
998998
}
999999
}
10001000
},
1001+
"/ocs/v2.php/apps/libresign/api/{apiVersion}/admin/signature-flow": {
1002+
"post": {
1003+
"operationId": "admin-set-signature-flow",
1004+
"summary": "Set signature flow configuration",
1005+
"description": "This endpoint requires admin access",
1006+
"tags": [
1007+
"admin"
1008+
],
1009+
"security": [
1010+
{
1011+
"bearer_auth": []
1012+
},
1013+
{
1014+
"basic_auth": []
1015+
}
1016+
],
1017+
"requestBody": {
1018+
"required": true,
1019+
"content": {
1020+
"application/json": {
1021+
"schema": {
1022+
"type": "object",
1023+
"required": [
1024+
"flow"
1025+
],
1026+
"properties": {
1027+
"flow": {
1028+
"type": "string",
1029+
"description": "Signature flow mode: 'parallel' or 'ordered_numeric'"
1030+
}
1031+
}
1032+
}
1033+
}
1034+
}
1035+
},
1036+
"parameters": [
1037+
{
1038+
"name": "apiVersion",
1039+
"in": "path",
1040+
"required": true,
1041+
"schema": {
1042+
"type": "string",
1043+
"enum": [
1044+
"v1"
1045+
],
1046+
"default": "v1"
1047+
}
1048+
},
1049+
{
1050+
"name": "OCS-APIRequest",
1051+
"in": "header",
1052+
"description": "Required to be true for the API request to pass",
1053+
"required": true,
1054+
"schema": {
1055+
"type": "boolean",
1056+
"default": true
1057+
}
1058+
}
1059+
],
1060+
"responses": {
1061+
"200": {
1062+
"description": "OK",
1063+
"content": {
1064+
"application/json": {
1065+
"schema": {
1066+
"type": "object",
1067+
"required": [
1068+
"ocs"
1069+
],
1070+
"properties": {
1071+
"ocs": {
1072+
"type": "object",
1073+
"required": [
1074+
"meta",
1075+
"data"
1076+
],
1077+
"properties": {
1078+
"meta": {
1079+
"$ref": "#/components/schemas/OCSMeta"
1080+
},
1081+
"data": {
1082+
"type": "object",
1083+
"required": [
1084+
"signature_flow"
1085+
],
1086+
"properties": {
1087+
"signature_flow": {
1088+
"type": "string"
1089+
}
1090+
}
1091+
}
1092+
}
1093+
}
1094+
}
1095+
}
1096+
}
1097+
}
1098+
},
1099+
"400": {
1100+
"description": "Invalid flow value",
1101+
"content": {
1102+
"application/json": {
1103+
"schema": {
1104+
"type": "object",
1105+
"required": [
1106+
"ocs"
1107+
],
1108+
"properties": {
1109+
"ocs": {
1110+
"type": "object",
1111+
"required": [
1112+
"meta",
1113+
"data"
1114+
],
1115+
"properties": {
1116+
"meta": {
1117+
"$ref": "#/components/schemas/OCSMeta"
1118+
},
1119+
"data": {
1120+
"type": "object",
1121+
"required": [
1122+
"message"
1123+
],
1124+
"properties": {
1125+
"message": {
1126+
"type": "string"
1127+
}
1128+
}
1129+
}
1130+
}
1131+
}
1132+
}
1133+
}
1134+
}
1135+
}
1136+
}
1137+
}
1138+
}
1139+
},
10011140
"/ocs/v2.php/apps/libresign/api/{apiVersion}/admin/signature-background": {
10021141
"post": {
10031142
"operationId": "admin-signature-background-save",

‎openapi-full.json‎

Lines changed: 141 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6381,7 +6381,7 @@
63816381
"post": {
63826382
"operationId": "request_signature-request",
63836383
"summary": "Request signature",
6384-
"description": "Request that a file be signed by a group of people",
6384+
"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.",
63856385
"tags": [
63866386
"request_signature"
63876387
],
@@ -6411,7 +6411,7 @@
64116411
},
64126412
"users": {
64136413
"type": "array",
6414-
"description": "Collection of users who must sign the document",
6414+
"description": "Collection of users who must sign the document. Each user can have: identify, displayName, description, notify, signing_order",
64156415
"items": {
64166416
"$ref": "#/components/schemas/NewSigner"
64176417
}
@@ -9475,6 +9475,145 @@
94759475
}
94769476
}
94779477
},
9478+
"/ocs/v2.php/apps/libresign/api/{apiVersion}/admin/signature-flow": {
9479+
"post": {
9480+
"operationId": "admin-set-signature-flow",
9481+
"summary": "Set signature flow configuration",
9482+
"description": "This endpoint requires admin access",
9483+
"tags": [
9484+
"admin"
9485+
],
9486+
"security": [
9487+
{
9488+
"bearer_auth": []
9489+
},
9490+
{
9491+
"basic_auth": []
9492+
}
9493+
],
9494+
"requestBody": {
9495+
"required": true,
9496+
"content": {
9497+
"application/json": {
9498+
"schema": {
9499+
"type": "object",
9500+
"required": [
9501+
"flow"
9502+
],
9503+
"properties": {
9504+
"flow": {
9505+
"type": "string",
9506+
"description": "Signature flow mode: 'parallel' or 'ordered_numeric'"
9507+
}
9508+
}
9509+
}
9510+
}
9511+
}
9512+
},
9513+
"parameters": [
9514+
{
9515+
"name": "apiVersion",
9516+
"in": "path",
9517+
"required": true,
9518+
"schema": {
9519+
"type": "string",
9520+
"enum": [
9521+
"v1"
9522+
],
9523+
"default": "v1"
9524+
}
9525+
},
9526+
{
9527+
"name": "OCS-APIRequest",
9528+
"in": "header",
9529+
"description": "Required to be true for the API request to pass",
9530+
"required": true,
9531+
"schema": {
9532+
"type": "boolean",
9533+
"default": true
9534+
}
9535+
}
9536+
],
9537+
"responses": {
9538+
"200": {
9539+
"description": "OK",
9540+
"content": {
9541+
"application/json": {
9542+
"schema": {
9543+
"type": "object",
9544+
"required": [
9545+
"ocs"
9546+
],
9547+
"properties": {
9548+
"ocs": {
9549+
"type": "object",
9550+
"required": [
9551+
"meta",
9552+
"data"
9553+
],
9554+
"properties": {
9555+
"meta": {
9556+
"$ref": "#/components/schemas/OCSMeta"
9557+
},
9558+
"data": {
9559+
"type": "object",
9560+
"required": [
9561+
"signature_flow"
9562+
],
9563+
"properties": {
9564+
"signature_flow": {
9565+
"type": "string"
9566+
}
9567+
}
9568+
}
9569+
}
9570+
}
9571+
}
9572+
}
9573+
}
9574+
}
9575+
},
9576+
"400": {
9577+
"description": "Invalid flow value",
9578+
"content": {
9579+
"application/json": {
9580+
"schema": {
9581+
"type": "object",
9582+
"required": [
9583+
"ocs"
9584+
],
9585+
"properties": {
9586+
"ocs": {
9587+
"type": "object",
9588+
"required": [
9589+
"meta",
9590+
"data"
9591+
],
9592+
"properties": {
9593+
"meta": {
9594+
"$ref": "#/components/schemas/OCSMeta"
9595+
},
9596+
"data": {
9597+
"type": "object",
9598+
"required": [
9599+
"message"
9600+
],
9601+
"properties": {
9602+
"message": {
9603+
"type": "string"
9604+
}
9605+
}
9606+
}
9607+
}
9608+
}
9609+
}
9610+
}
9611+
}
9612+
}
9613+
}
9614+
}
9615+
}
9616+
},
94789617
"/ocs/v2.php/apps/libresign/api/{apiVersion}/admin/signature-background": {
94799618
"post": {
94809619
"operationId": "admin-signature-background-save",

‎openapi.json‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6231,7 +6231,7 @@
62316231
"post": {
62326232
"operationId": "request_signature-request",
62336233
"summary": "Request signature",
6234-
"description": "Request that a file be signed by a group of people",
6234+
"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.",
62356235
"tags": [
62366236
"request_signature"
62376237
],
@@ -6261,7 +6261,7 @@
62616261
},
62626262
"users": {
62636263
"type": "array",
6264-
"description": "Collection of users who must sign the document",
6264+
"description": "Collection of users who must sign the document. Each user can have: identify, displayName, description, notify, signing_order",
62656265
"items": {
62666266
"$ref": "#/components/schemas/NewSigner"
62676267
}

0 commit comments

Comments
 (0)