Skip to content

feat: Adding docs for file validations errors #907

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
satyamyesj wants to merge 2 commits into
base: main
Choose a base branch
from
Open

feat: Adding docs for file validations errors #907

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
b141249
feat: Adding docs for file validations errors
satyamyesj Sep 22, 2026
6ed73e6
Auto generate API docs
satyamyesj Oct 5, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
100 changes: 98 additions & 2 deletions reference/admin.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13155,7 +13155,44 @@ paths:
content:
application/json:
schema:
$ref: '#/components/schemas/400'
oneOf:
- $ref: '#/components/schemas/400'
- $ref: '#/components/schemas/statement_upload_error_out'
examples:
invalid_usage:
summary: File id is incorrect or does not belong to the user/org
value:
message: File id is incorrect and no such file exists
statement_upload_exception:
summary: File failed multiple validations while parsing
value:
data:
- title: Empty Header
description: A column header is empty.
action: Please add a value for each header.
column_number: 2
column_label: B
column_name: null
row_numbers:
- 1
- title: Columns Without Header
description: Some columns in your file do not have names.
action: Please add the missing column names.
column_number: null
column_label: null
column_name: null
row_numbers:
- 4
- title: Empty Row
description: Row is empty.
action: Please remove it.
column_number: null
column_label: null
column_name: null
row_numbers:
- 3
error: StatementUploadException
message: Errors were found while processing your file.
'401':
description: Unauthorized request
content:
Expand Down Expand Up @@ -37590,6 +37627,66 @@ components:
example: fidftadfdsdf
required:
- file_id
statement_upload_error_out:
type: object
additionalProperties: false
required:
- data
- error
- message
properties:
data:
type: array
nullable: true
description: |
List of validation errors found while parsing the uploaded statement file.
items:
type: object
additionalProperties: false
properties:
title:
type: string
description: |
Short, human readable name of the validation error.
description:
type: string
description: |
Human readable description of the validation error.
action:
type: string
description: |
Suggested action the user can take to resolve the validation error.
row_numbers:
type: array
nullable: true
items:
type: integer
description: |
1-indexed row numbers (including the header row) where the error was found. Multiple rows with the same error type and column are grouped together.
column_number:
type: integer
nullable: true
description: |
1-indexed column number where the error was found.
column_label:
type: string
nullable: true
description: |
Excel-style column label (A, B, C, ...) where the error was found.
column_name:
type: string
nullable: true
description: |
Name of the column header where the error was found.
error:
type: string
enum:
- StatementUploadException
message:
type: string
description: |
Summary message describing that errors were found while processing the uploaded file.
example: false
statement_mappings_out:
type: object
additionalProperties: false
Expand Down Expand Up @@ -38831,7 +38928,6 @@ components:
type: boolean
description: |
Indicates whether every distinct card number found in the statement is unmatched.
example: false
matching_cards_out:
type: object
required:
Expand Down
39 changes: 38 additions & 1 deletion src/admin/paths/admin@statements@upload.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,44 @@ post:
content:
application/json:
schema:
$ref: '../../components/schemas/400.yaml'
oneOf:
- $ref: '../../components/schemas/400.yaml'
- $ref: '../../components/schemas/statements.yaml#/statement_upload_error_out'
examples:
invalid_usage:
summary: File id is incorrect or does not belong to the user/org
value:
message: File id is incorrect and no such file exists
statement_upload_exception:
summary: File failed multiple validations while parsing
value:
data:
- title: Empty Header
description: A column header is empty.
action: Please add a value for each header.
column_number: 2
column_label: B
column_name: null
row_numbers:
- 1
- title: Columns Without Header
description: Some columns in your file do not have names.
action: Please add the missing column names.
column_number: null
column_label: null
column_name: null
row_numbers:
- 4
- title: Empty Row
description: Row is empty.
action: Please remove it.
column_number: null
column_label: null
column_name: null
row_numbers:
- 3
error: StatementUploadException
message: Errors were found while processing your file.
'401':
description: Unauthorized request
content:
Expand Down
60 changes: 60 additions & 0 deletions src/components/schemas/statements.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1708,4 +1708,64 @@ unmatched_cards_out:
type: boolean
description: |
Indicates whether every distinct card number found in the statement is unmatched.

statement_upload_error_out:
type: object
additionalProperties: false
required:
- data
- error
- message
properties:
data:
type: array
nullable: true
description: |
List of validation errors found while parsing the uploaded statement file.
items:
type: object
additionalProperties: false
properties:
title:
type: string
description: |
Short, human readable name of the validation error.
description:
type: string
description: |
Human readable description of the validation error.
action:
type: string
description: |
Suggested action the user can take to resolve the validation error.
row_numbers:
type: array
nullable: true
items:
type: integer
description: |
1-indexed row numbers (including the header row) where the error was found. Multiple rows with the same error type and column are grouped together.
column_number:
type: integer
nullable: true
description: |
1-indexed column number where the error was found.
column_label:
type: string
nullable: true
description: |
Excel-style column label (A, B, C, ...) where the error was found.
column_name:
type: string
nullable: true
description: |
Name of the column header where the error was found.
error:
type: string
enum:
- StatementUploadException
message:
type: string
description: |
Summary message describing that errors were found while processing the uploaded file.
example: false
Loading