Skip to content

Commit f0c7dd6

Browse files
chore: add documentation of openapi
Signed-off-by: Vitor Mattos <[email protected]>
1 parent 1c13752 commit f0c7dd6

File tree

4 files changed

+22
-8
lines changed

4 files changed

+22
-8
lines changed

openapi-administration.json

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2987,12 +2987,17 @@
29872987
"schema": {
29882988
"type": "object",
29892989
"required": [
2990-
"mode"
2990+
"enabled"
29912991
],
29922992
"properties": {
2993+
"enabled": {
2994+
"type": "boolean",
2995+
"description": "Whether to force a signature flow for all documents"
2996+
},
29932997
"mode": {
29942998
"type": "string",
2995-
"description": "Signature flow mode: 'parallel' or 'ordered_numeric'"
2999+
"nullable": true,
3000+
"description": "Signature flow mode: 'parallel' or 'ordered_numeric' (only used when enabled is true)"
29963001
}
29973002
}
29983003
}

openapi-full.json

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11504,12 +11504,17 @@
1150411504
"schema": {
1150511505
"type": "object",
1150611506
"required": [
11507-
"mode"
11507+
"enabled"
1150811508
],
1150911509
"properties": {
11510+
"enabled": {
11511+
"type": "boolean",
11512+
"description": "Whether to force a signature flow for all documents"
11513+
},
1151011514
"mode": {
1151111515
"type": "string",
11512-
"description": "Signature flow mode: 'parallel' or 'ordered_numeric'"
11516+
"nullable": true,
11517+
"description": "Signature flow mode: 'parallel' or 'ordered_numeric' (only used when enabled is true)"
1151311518
}
1151411519
}
1151511520
}

src/types/openapi/openapi-administration.ts

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1635,8 +1635,10 @@ export interface operations {
16351635
requestBody: {
16361636
content: {
16371637
"application/json": {
1638-
/** @description Signature flow mode: 'parallel' or 'ordered_numeric' */
1639-
mode: string;
1638+
/** @description Whether to force a signature flow for all documents */
1639+
enabled: boolean;
1640+
/** @description Signature flow mode: 'parallel' or 'ordered_numeric' (only used when enabled is true) */
1641+
mode?: string | null;
16401642
};
16411643
};
16421644
};

src/types/openapi/openapi-full.ts

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6048,8 +6048,10 @@ export interface operations {
60486048
requestBody: {
60496049
content: {
60506050
"application/json": {
6051-
/** @description Signature flow mode: 'parallel' or 'ordered_numeric' */
6052-
mode: string;
6051+
/** @description Whether to force a signature flow for all documents */
6052+
enabled: boolean;
6053+
/** @description Signature flow mode: 'parallel' or 'ordered_numeric' (only used when enabled is true) */
6054+
mode?: string | null;
60536055
};
60546056
};
60556057
};

0 commit comments

Comments
 (0)