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 <1079143+vitormattos@users.noreply.github.com>
This commit is contained in:
Vitor Mattos 2025-12-09 21:46:35 -03:00
parent 0367e5329c
commit 5c6fc226c1
No known key found for this signature in database
GPG key ID: 6FECE2AD4809003A
4 changed files with 536 additions and 428 deletions

View file

@ -998,145 +998,6 @@
}
}
},
"/ocs/v2.php/apps/libresign/api/{apiVersion}/admin/signature-flow": {
"post": {
"operationId": "admin-set-signature-flow",
"summary": "Set signature flow configuration",
"description": "This endpoint requires admin access",
"tags": [
"admin"
],
"security": [
{
"bearer_auth": []
},
{
"basic_auth": []
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"flow"
],
"properties": {
"flow": {
"type": "string",
"description": "Signature flow mode: 'parallel' or 'ordered_numeric'"
}
}
}
}
}
},
"parameters": [
{
"name": "apiVersion",
"in": "path",
"required": true,
"schema": {
"type": "string",
"enum": [
"v1"
],
"default": "v1"
}
},
{
"name": "OCS-APIRequest",
"in": "header",
"description": "Required to be true for the API request to pass",
"required": true,
"schema": {
"type": "boolean",
"default": true
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"ocs"
],
"properties": {
"ocs": {
"type": "object",
"required": [
"meta",
"data"
],
"properties": {
"meta": {
"$ref": "#/components/schemas/OCSMeta"
},
"data": {
"type": "object",
"required": [
"signature_flow"
],
"properties": {
"signature_flow": {
"type": "string"
}
}
}
}
}
}
}
}
}
},
"400": {
"description": "Invalid flow value",
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"ocs"
],
"properties": {
"ocs": {
"type": "object",
"required": [
"meta",
"data"
],
"properties": {
"meta": {
"$ref": "#/components/schemas/OCSMeta"
},
"data": {
"type": "object",
"required": [
"message"
],
"properties": {
"message": {
"type": "string"
}
}
}
}
}
}
}
}
}
}
}
}
},
"/ocs/v2.php/apps/libresign/api/{apiVersion}/admin/signature-background": {
"post": {
"operationId": "admin-signature-background-save",
@ -3103,6 +2964,183 @@
}
}
},
"/ocs/v2.php/apps/libresign/api/{apiVersion}/admin/signature-flow/config": {
"post": {
"operationId": "admin-set-signature-flow-config",
"summary": "Set signature flow configuration",
"description": "This endpoint requires admin access",
"tags": [
"admin"
],
"security": [
{
"bearer_auth": []
},
{
"basic_auth": []
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"mode"
],
"properties": {
"mode": {
"type": "string",
"description": "Signature flow mode: 'parallel' or 'ordered_numeric'"
}
}
}
}
}
},
"parameters": [
{
"name": "apiVersion",
"in": "path",
"required": true,
"schema": {
"type": "string",
"enum": [
"v1"
],
"default": "v1"
}
},
{
"name": "OCS-APIRequest",
"in": "header",
"description": "Required to be true for the API request to pass",
"required": true,
"schema": {
"type": "boolean",
"default": true
}
}
],
"responses": {
"200": {
"description": "Configuration saved successfully",
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"ocs"
],
"properties": {
"ocs": {
"type": "object",
"required": [
"meta",
"data"
],
"properties": {
"meta": {
"$ref": "#/components/schemas/OCSMeta"
},
"data": {
"type": "object",
"required": [
"message"
],
"properties": {
"message": {
"type": "string"
}
}
}
}
}
}
}
}
}
},
"400": {
"description": "Invalid signature flow mode provided",
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"ocs"
],
"properties": {
"ocs": {
"type": "object",
"required": [
"meta",
"data"
],
"properties": {
"meta": {
"$ref": "#/components/schemas/OCSMeta"
},
"data": {
"type": "object",
"required": [
"error"
],
"properties": {
"error": {
"type": "string"
}
}
}
}
}
}
}
}
}
},
"500": {
"description": "Internal server error",
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"ocs"
],
"properties": {
"ocs": {
"type": "object",
"required": [
"meta",
"data"
],
"properties": {
"meta": {
"$ref": "#/components/schemas/OCSMeta"
},
"data": {
"type": "object",
"required": [
"error"
],
"properties": {
"error": {
"type": "string"
}
}
}
}
}
}
}
}
}
}
}
}
},
"/ocs/v2.php/apps/libresign/api/{apiVersion}/admin/docmdp/config": {
"post": {
"operationId": "admin-set-doc-mdp-config",

View file

@ -9475,145 +9475,6 @@
}
}
},
"/ocs/v2.php/apps/libresign/api/{apiVersion}/admin/signature-flow": {
"post": {
"operationId": "admin-set-signature-flow",
"summary": "Set signature flow configuration",
"description": "This endpoint requires admin access",
"tags": [
"admin"
],
"security": [
{
"bearer_auth": []
},
{
"basic_auth": []
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"flow"
],
"properties": {
"flow": {
"type": "string",
"description": "Signature flow mode: 'parallel' or 'ordered_numeric'"
}
}
}
}
}
},
"parameters": [
{
"name": "apiVersion",
"in": "path",
"required": true,
"schema": {
"type": "string",
"enum": [
"v1"
],
"default": "v1"
}
},
{
"name": "OCS-APIRequest",
"in": "header",
"description": "Required to be true for the API request to pass",
"required": true,
"schema": {
"type": "boolean",
"default": true
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"ocs"
],
"properties": {
"ocs": {
"type": "object",
"required": [
"meta",
"data"
],
"properties": {
"meta": {
"$ref": "#/components/schemas/OCSMeta"
},
"data": {
"type": "object",
"required": [
"signature_flow"
],
"properties": {
"signature_flow": {
"type": "string"
}
}
}
}
}
}
}
}
}
},
"400": {
"description": "Invalid flow value",
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"ocs"
],
"properties": {
"ocs": {
"type": "object",
"required": [
"meta",
"data"
],
"properties": {
"meta": {
"$ref": "#/components/schemas/OCSMeta"
},
"data": {
"type": "object",
"required": [
"message"
],
"properties": {
"message": {
"type": "string"
}
}
}
}
}
}
}
}
}
}
}
}
},
"/ocs/v2.php/apps/libresign/api/{apiVersion}/admin/signature-background": {
"post": {
"operationId": "admin-signature-background-save",
@ -11580,6 +11441,183 @@
}
}
},
"/ocs/v2.php/apps/libresign/api/{apiVersion}/admin/signature-flow/config": {
"post": {
"operationId": "admin-set-signature-flow-config",
"summary": "Set signature flow configuration",
"description": "This endpoint requires admin access",
"tags": [
"admin"
],
"security": [
{
"bearer_auth": []
},
{
"basic_auth": []
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"mode"
],
"properties": {
"mode": {
"type": "string",
"description": "Signature flow mode: 'parallel' or 'ordered_numeric'"
}
}
}
}
}
},
"parameters": [
{
"name": "apiVersion",
"in": "path",
"required": true,
"schema": {
"type": "string",
"enum": [
"v1"
],
"default": "v1"
}
},
{
"name": "OCS-APIRequest",
"in": "header",
"description": "Required to be true for the API request to pass",
"required": true,
"schema": {
"type": "boolean",
"default": true
}
}
],
"responses": {
"200": {
"description": "Configuration saved successfully",
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"ocs"
],
"properties": {
"ocs": {
"type": "object",
"required": [
"meta",
"data"
],
"properties": {
"meta": {
"$ref": "#/components/schemas/OCSMeta"
},
"data": {
"type": "object",
"required": [
"message"
],
"properties": {
"message": {
"type": "string"
}
}
}
}
}
}
}
}
}
},
"400": {
"description": "Invalid signature flow mode provided",
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"ocs"
],
"properties": {
"ocs": {
"type": "object",
"required": [
"meta",
"data"
],
"properties": {
"meta": {
"$ref": "#/components/schemas/OCSMeta"
},
"data": {
"type": "object",
"required": [
"error"
],
"properties": {
"error": {
"type": "string"
}
}
}
}
}
}
}
}
}
},
"500": {
"description": "Internal server error",
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"ocs"
],
"properties": {
"ocs": {
"type": "object",
"required": [
"meta",
"data"
],
"properties": {
"meta": {
"$ref": "#/components/schemas/OCSMeta"
},
"data": {
"type": "object",
"required": [
"error"
],
"properties": {
"error": {
"type": "string"
}
}
}
}
}
}
}
}
}
}
}
}
},
"/ocs/v2.php/apps/libresign/api/{apiVersion}/admin/docmdp/config": {
"post": {
"operationId": "admin-set-doc-mdp-config",

View file

@ -128,26 +128,6 @@ export type paths = {
patch?: never;
trace?: never;
};
"/ocs/v2.php/apps/libresign/api/{apiVersion}/admin/signature-flow": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
/**
* Set signature flow configuration
* @description This endpoint requires admin access
*/
post: operations["admin-set-signature-flow"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/ocs/v2.php/apps/libresign/api/{apiVersion}/admin/signature-background": {
parameters: {
query?: never;
@ -364,6 +344,26 @@ export type paths = {
patch?: never;
trace?: never;
};
"/ocs/v2.php/apps/libresign/api/{apiVersion}/admin/signature-flow/config": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
/**
* Set signature flow configuration
* @description This endpoint requires admin access
*/
post: operations["admin-set-signature-flow-config"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/ocs/v2.php/apps/libresign/api/{apiVersion}/admin/docmdp/config": {
parameters: {
query?: never;
@ -810,61 +810,6 @@ export interface operations {
};
};
};
"admin-set-signature-flow": {
parameters: {
query?: never;
header: {
/** @description Required to be true for the API request to pass */
"OCS-APIRequest": boolean;
};
path: {
apiVersion: "v1";
};
cookie?: never;
};
requestBody: {
content: {
"application/json": {
/** @description Signature flow mode: 'parallel' or 'ordered_numeric' */
flow: string;
};
};
};
responses: {
/** @description OK */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": {
ocs: {
meta: components["schemas"]["OCSMeta"];
data: {
signature_flow: string;
};
};
};
};
};
/** @description Invalid flow value */
400: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": {
ocs: {
meta: components["schemas"]["OCSMeta"];
data: {
message: string;
};
};
};
};
};
};
};
"admin-signature-background-get": {
parameters: {
query?: never;
@ -1675,6 +1620,77 @@ export interface operations {
};
};
};
"admin-set-signature-flow-config": {
parameters: {
query?: never;
header: {
/** @description Required to be true for the API request to pass */
"OCS-APIRequest": boolean;
};
path: {
apiVersion: "v1";
};
cookie?: never;
};
requestBody: {
content: {
"application/json": {
/** @description Signature flow mode: 'parallel' or 'ordered_numeric' */
mode: string;
};
};
};
responses: {
/** @description Configuration saved successfully */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": {
ocs: {
meta: components["schemas"]["OCSMeta"];
data: {
message: string;
};
};
};
};
};
/** @description Invalid signature flow mode provided */
400: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": {
ocs: {
meta: components["schemas"]["OCSMeta"];
data: {
error: string;
};
};
};
};
};
/** @description Internal server error */
500: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": {
ocs: {
meta: components["schemas"]["OCSMeta"];
data: {
error: string;
};
};
};
};
};
};
};
"admin-set-doc-mdp-config": {
parameters: {
query?: never;

View file

@ -1139,26 +1139,6 @@ export type paths = {
patch?: never;
trace?: never;
};
"/ocs/v2.php/apps/libresign/api/{apiVersion}/admin/signature-flow": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
/**
* Set signature flow configuration
* @description This endpoint requires admin access
*/
post: operations["admin-set-signature-flow"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/ocs/v2.php/apps/libresign/api/{apiVersion}/admin/signature-background": {
parameters: {
query?: never;
@ -1375,6 +1355,26 @@ export type paths = {
patch?: never;
trace?: never;
};
"/ocs/v2.php/apps/libresign/api/{apiVersion}/admin/signature-flow/config": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
/**
* Set signature flow configuration
* @description This endpoint requires admin access
*/
post: operations["admin-set-signature-flow-config"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/ocs/v2.php/apps/libresign/api/{apiVersion}/admin/docmdp/config": {
parameters: {
query?: never;
@ -5206,61 +5206,6 @@ export interface operations {
};
};
};
"admin-set-signature-flow": {
parameters: {
query?: never;
header: {
/** @description Required to be true for the API request to pass */
"OCS-APIRequest": boolean;
};
path: {
apiVersion: "v1";
};
cookie?: never;
};
requestBody: {
content: {
"application/json": {
/** @description Signature flow mode: 'parallel' or 'ordered_numeric' */
flow: string;
};
};
};
responses: {
/** @description OK */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": {
ocs: {
meta: components["schemas"]["OCSMeta"];
data: {
signature_flow: string;
};
};
};
};
};
/** @description Invalid flow value */
400: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": {
ocs: {
meta: components["schemas"]["OCSMeta"];
data: {
message: string;
};
};
};
};
};
};
};
"admin-signature-background-get": {
parameters: {
query?: never;
@ -6071,6 +6016,77 @@ export interface operations {
};
};
};
"admin-set-signature-flow-config": {
parameters: {
query?: never;
header: {
/** @description Required to be true for the API request to pass */
"OCS-APIRequest": boolean;
};
path: {
apiVersion: "v1";
};
cookie?: never;
};
requestBody: {
content: {
"application/json": {
/** @description Signature flow mode: 'parallel' or 'ordered_numeric' */
mode: string;
};
};
};
responses: {
/** @description Configuration saved successfully */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": {
ocs: {
meta: components["schemas"]["OCSMeta"];
data: {
message: string;
};
};
};
};
};
/** @description Invalid signature flow mode provided */
400: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": {
ocs: {
meta: components["schemas"]["OCSMeta"];
data: {
error: string;
};
};
};
};
};
/** @description Internal server error */
500: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": {
ocs: {
meta: components["schemas"]["OCSMeta"];
data: {
error: string;
};
};
};
};
};
};
};
"admin-set-doc-mdp-config": {
parameters: {
query?: never;