Skip to content

Commit c521a0f

Browse files
committed
docs(openapi): align validation descriptions with unified files collection
Signed-off-by: Vitor Mattos <1079143+vitormattos@users.noreply.github.com>
1 parent cc27b53 commit c521a0f

1 file changed

Lines changed: 3 additions & 3 deletions

File tree

openapi.json

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4237,7 +4237,7 @@
42374237
"get": {
42384238
"operationId": "file-validate-uuid",
42394239
"summary": "Validate a file using Uuid",
4240-
"description": "Validate a file returning file data. When `nodeType` is `envelope`, the response includes `filesCount` and `files` as a list of envelope child files.",
4240+
"description": "Validate a file returning file data. The response always includes `filesCount` and `files`. For `nodeType=file`, `filesCount=1` and `files` contains the current file. For `nodeType=envelope`, `files` contains envelope child files.",
42414241
"tags": [
42424242
"file"
42434243
],
@@ -4390,7 +4390,7 @@
43904390
"get": {
43914391
"operationId": "file-validate-file-id",
43924392
"summary": "Validate a file using FileId",
4393-
"description": "Validate a file returning file data. When `nodeType` is `envelope`, the response includes `filesCount` and `files` as a list of envelope child files.",
4393+
"description": "Validate a file returning file data. The response always includes `filesCount` and `files`. For `nodeType=file`, `filesCount=1` and `files` contains the current file. For `nodeType=envelope`, `files` contains envelope child files.",
43944394
"tags": [
43954395
"file"
43964396
],
@@ -4544,7 +4544,7 @@
45444544
"post": {
45454545
"operationId": "file-validate-binary",
45464546
"summary": "Validate a binary file",
4547-
"description": "Validate a binary file returning file data. Use field 'file' for the file upload. When `nodeType` is `envelope`, the response includes `filesCount` and `files` as a list of envelope child files.",
4547+
"description": "Validate a binary file returning file data. Use field 'file' for the file upload. The response always includes `filesCount` and `files`. For `nodeType=file`, `filesCount=1` and `files` contains the current file. For `nodeType=envelope`, `files` contains envelope child files.",
45484548
"tags": [
45494549
"file"
45504550
],

0 commit comments

Comments
 (0)