From 0c5461f16ceb0e6a74e4fe4b218f8715a7e13082 Mon Sep 17 00:00:00 2001 From: Vitor Mattos <1079143+vitormattos@users.noreply.github.com> Date: Tue, 16 Dec 2025 20:52:16 -0300 Subject: [PATCH] chore: add documentation of openapi Signed-off-by: Vitor Mattos <1079143+vitormattos@users.noreply.github.com> --- openapi-administration.json | 9 +++++++-- openapi-full.json | 9 +++++++-- src/types/openapi/openapi-administration.ts | 6 ++++-- src/types/openapi/openapi-full.ts | 6 ++++-- 4 files changed, 22 insertions(+), 8 deletions(-) diff --git a/openapi-administration.json b/openapi-administration.json index 94e998b68..7e503d90a 100644 --- a/openapi-administration.json +++ b/openapi-administration.json @@ -2987,12 +2987,17 @@ "schema": { "type": "object", "required": [ - "mode" + "enabled" ], "properties": { + "enabled": { + "type": "boolean", + "description": "Whether to force a signature flow for all documents" + }, "mode": { "type": "string", - "description": "Signature flow mode: 'parallel' or 'ordered_numeric'" + "nullable": true, + "description": "Signature flow mode: 'parallel' or 'ordered_numeric' (only used when enabled is true)" } } } diff --git a/openapi-full.json b/openapi-full.json index de9ee08dc..410bdc6f7 100644 --- a/openapi-full.json +++ b/openapi-full.json @@ -11504,12 +11504,17 @@ "schema": { "type": "object", "required": [ - "mode" + "enabled" ], "properties": { + "enabled": { + "type": "boolean", + "description": "Whether to force a signature flow for all documents" + }, "mode": { "type": "string", - "description": "Signature flow mode: 'parallel' or 'ordered_numeric'" + "nullable": true, + "description": "Signature flow mode: 'parallel' or 'ordered_numeric' (only used when enabled is true)" } } } diff --git a/src/types/openapi/openapi-administration.ts b/src/types/openapi/openapi-administration.ts index 1ff8e4a66..7398f8c83 100644 --- a/src/types/openapi/openapi-administration.ts +++ b/src/types/openapi/openapi-administration.ts @@ -1635,8 +1635,10 @@ export interface operations { requestBody: { content: { "application/json": { - /** @description Signature flow mode: 'parallel' or 'ordered_numeric' */ - mode: string; + /** @description Whether to force a signature flow for all documents */ + enabled: boolean; + /** @description Signature flow mode: 'parallel' or 'ordered_numeric' (only used when enabled is true) */ + mode?: string | null; }; }; }; diff --git a/src/types/openapi/openapi-full.ts b/src/types/openapi/openapi-full.ts index d62a0f562..d3b0efb37 100644 --- a/src/types/openapi/openapi-full.ts +++ b/src/types/openapi/openapi-full.ts @@ -6048,8 +6048,10 @@ export interface operations { requestBody: { content: { "application/json": { - /** @description Signature flow mode: 'parallel' or 'ordered_numeric' */ - mode: string; + /** @description Whether to force a signature flow for all documents */ + enabled: boolean; + /** @description Signature flow mode: 'parallel' or 'ordered_numeric' (only used when enabled is true) */ + mode?: string | null; }; }; };