Skip to content

Commit 20c8021

Browse files
vitormattosvitormattos
committed
chore: update OpenAPI specs for signature flow endpoint
Regenerate OpenAPI documentation files to include the new signature flow configuration endpoint. Signed-off-by: Vitor Mattos <[email protected]>
1 parent 60661e1 commit 20c8021

File tree

4 files changed

+536
-428
lines changed

4 files changed

+536
-428
lines changed

‎openapi-administration.json‎

Lines changed: 177 additions & 139 deletions
Original file line numberDiff line numberDiff line change
@@ -998,145 +998,6 @@
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-
},
11401001
"/ocs/v2.php/apps/libresign/api/{apiVersion}/admin/signature-background": {
11411002
"post": {
11421003
"operationId": "admin-signature-background-save",
@@ -3103,6 +2964,183 @@
31032964
}
31042965
}
31052966
},
2967+
"/ocs/v2.php/apps/libresign/api/{apiVersion}/admin/signature-flow/config": {
2968+
"post": {
2969+
"operationId": "admin-set-signature-flow-config",
2970+
"summary": "Set signature flow configuration",
2971+
"description": "This endpoint requires admin access",
2972+
"tags": [
2973+
"admin"
2974+
],
2975+
"security": [
2976+
{
2977+
"bearer_auth": []
2978+
},
2979+
{
2980+
"basic_auth": []
2981+
}
2982+
],
2983+
"requestBody": {
2984+
"required": true,
2985+
"content": {
2986+
"application/json": {
2987+
"schema": {
2988+
"type": "object",
2989+
"required": [
2990+
"mode"
2991+
],
2992+
"properties": {
2993+
"mode": {
2994+
"type": "string",
2995+
"description": "Signature flow mode: 'parallel' or 'ordered_numeric'"
2996+
}
2997+
}
2998+
}
2999+
}
3000+
}
3001+
},
3002+
"parameters": [
3003+
{
3004+
"name": "apiVersion",
3005+
"in": "path",
3006+
"required": true,
3007+
"schema": {
3008+
"type": "string",
3009+
"enum": [
3010+
"v1"
3011+
],
3012+
"default": "v1"
3013+
}
3014+
},
3015+
{
3016+
"name": "OCS-APIRequest",
3017+
"in": "header",
3018+
"description": "Required to be true for the API request to pass",
3019+
"required": true,
3020+
"schema": {
3021+
"type": "boolean",
3022+
"default": true
3023+
}
3024+
}
3025+
],
3026+
"responses": {
3027+
"200": {
3028+
"description": "Configuration saved successfully",
3029+
"content": {
3030+
"application/json": {
3031+
"schema": {
3032+
"type": "object",
3033+
"required": [
3034+
"ocs"
3035+
],
3036+
"properties": {
3037+
"ocs": {
3038+
"type": "object",
3039+
"required": [
3040+
"meta",
3041+
"data"
3042+
],
3043+
"properties": {
3044+
"meta": {
3045+
"$ref": "#/components/schemas/OCSMeta"
3046+
},
3047+
"data": {
3048+
"type": "object",
3049+
"required": [
3050+
"message"
3051+
],
3052+
"properties": {
3053+
"message": {
3054+
"type": "string"
3055+
}
3056+
}
3057+
}
3058+
}
3059+
}
3060+
}
3061+
}
3062+
}
3063+
}
3064+
},
3065+
"400": {
3066+
"description": "Invalid signature flow mode provided",
3067+
"content": {
3068+
"application/json": {
3069+
"schema": {
3070+
"type": "object",
3071+
"required": [
3072+
"ocs"
3073+
],
3074+
"properties": {
3075+
"ocs": {
3076+
"type": "object",
3077+
"required": [
3078+
"meta",
3079+
"data"
3080+
],
3081+
"properties": {
3082+
"meta": {
3083+
"$ref": "#/components/schemas/OCSMeta"
3084+
},
3085+
"data": {
3086+
"type": "object",
3087+
"required": [
3088+
"error"
3089+
],
3090+
"properties": {
3091+
"error": {
3092+
"type": "string"
3093+
}
3094+
}
3095+
}
3096+
}
3097+
}
3098+
}
3099+
}
3100+
}
3101+
}
3102+
},
3103+
"500": {
3104+
"description": "Internal server error",
3105+
"content": {
3106+
"application/json": {
3107+
"schema": {
3108+
"type": "object",
3109+
"required": [
3110+
"ocs"
3111+
],
3112+
"properties": {
3113+
"ocs": {
3114+
"type": "object",
3115+
"required": [
3116+
"meta",
3117+
"data"
3118+
],
3119+
"properties": {
3120+
"meta": {
3121+
"$ref": "#/components/schemas/OCSMeta"
3122+
},
3123+
"data": {
3124+
"type": "object",
3125+
"required": [
3126+
"error"
3127+
],
3128+
"properties": {
3129+
"error": {
3130+
"type": "string"
3131+
}
3132+
}
3133+
}
3134+
}
3135+
}
3136+
}
3137+
}
3138+
}
3139+
}
3140+
}
3141+
}
3142+
}
3143+
},
31063144
"/ocs/v2.php/apps/libresign/api/{apiVersion}/admin/docmdp/config": {
31073145
"post": {
31083146
"operationId": "admin-set-doc-mdp-config",

0 commit comments

Comments
 (0)