Skip to content

Commit

Permalink
feat: Added documentation for /admin/employees/potential_duplicate_ex…
Browse files Browse the repository at this point in the history
…penses API
  • Loading branch information
satyamyesj committed Aug 6, 2024
1 parent 1584246 commit 3b71f49
Show file tree
Hide file tree
Showing 3 changed files with 56 additions and 0 deletions.
2 changes: 2 additions & 0 deletions src/admin/openapi.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -169,6 +169,8 @@ paths:
$ref: paths/admin@levels.yaml
/admin/employees:
$ref: paths/admin@employees.yaml
/admin/employees/potential_duplicate_expenses:
$ref: paths/admin@employees@potential_duplicate_expenses.yaml
/admin/employees/business_units:
$ref: paths/admin@employees@business_units.yaml
/admin/employees/titles:
Expand Down
36 changes: 36 additions & 0 deletions src/admin/paths/admin@employees@potential_duplicate_expenses.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
get:
tags:
- Employees
summary: List employees and potential duplicate expenses
operationId: employees_list
description: |
This API supports very rich filtering on all response fields and pagination via query parameters. To understand how to use these parameters, please see the [Guide to Data APIs](https://docs.fylehq.com/docs/fyle-platform-docs/ZG9jOjI3Mzk2NTM3-guide-to-data-ap-is#filtering)
responses:
'200':
description: OK
content:
application/json:
schema:
type: object
additionalProperties: False
properties:
count:
$ref: ../../components/schemas/count.yaml
offset:
$ref: ../../components/schemas/offset.yaml
data:
type: array
items:
$ref: ../../components/schemas/employee.yaml#/employee_out_potential_duplicate_expenses
'400':
description: Bad request
content:
application/json:
schema:
$ref: ../../components/schemas/400.yaml
'401':
description: Unauthorized request
content:
application/json:
schema:
$ref: ../../components/schemas/401.yaml
18 changes: 18 additions & 0 deletions src/components/schemas/employee.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -267,6 +267,24 @@ employee_out_embed:
# nullable: true
# example: Finance ops

employee_out_potential_duplicate_expenses:
type: object
additionalProperties: False
properties:
user_id:
$ref: './fields.yaml#/user_id'
email:
$ref: './fields.yaml#/email'
full_name:
type: string
maxLength: 255
description: |
Represents the full name of the Employee. Must be at least 3 characters.
example: John Doe
potential_duplicate_expenses:
type: array
items:
$ref: ../../components/schemas/expense.yaml#/expense_duplicate_sets_out

employee_out_embed_for_expense:
type: object
Expand Down

0 comments on commit 3b71f49

Please sign in to comment.