From e7c63852484c9055fd432288a406831e9a74d1d8 Mon Sep 17 00:00:00 2001 From: Roshan Mhatre Date: Tue, 8 Oct 2024 14:29:17 +0530 Subject: [PATCH] feat: Docs for `POST admin/corporate_card_transactions/reassign/bulk` (#550) * feat: Add POST admin/corporate_card_transactions/reassign/bulk API Docs * Auto generate API docs --------- Co-authored-by: Siva --- reference/admin.yaml | 69 +++++++++++++++++++ src/admin/openapi.yaml | 2 + ...orate_card_transactions@reassign@bulk.yaml | 53 ++++++++++++++ .../schemas/corporate_card_transaction.yaml | 16 +++++ 4 files changed, 140 insertions(+) create mode 100644 src/admin/paths/admin@corporate_card_transactions@reassign@bulk.yaml diff --git a/reference/admin.yaml b/reference/admin.yaml index 238248102..641aec10a 100644 --- a/reference/admin.yaml +++ b/reference/admin.yaml @@ -8000,6 +8000,21 @@ components: - matched_expenses - last_user_matched_at - metadata + corporate_card_transaction_reassign_in: + type: object + properties: + id: + allOf: + - $ref: '#/components/schemas/id_string' + example: btxnwownwrng + user_id: + type: string + description: | + The unique id of an user to whom the card transaction should be reassigned. + example: usge49ielgel + required: + - id + - user_id corporate_card_transaction_id_in: type: object properties: @@ -20253,6 +20268,60 @@ paths: application/json: schema: $ref: '#/components/schemas/403' + /admin/corporate_card_transactions/reassign/bulk: + post: + tags: + - Corporate Card Transactions + summary: Bulk reassign corporate card transactions + description: | + Reassign corporate card transactions to users in bulk. + operationId: corporate_card_transactions_reassign_bulk + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + data: + type: array + items: + $ref: '#/components/schemas/corporate_card_transaction_reassign_in' + required: + - data + responses: + '200': + description: OK + '400': + description: Bad request + content: + application/json: + schema: + oneOf: + - $ref: '#/components/schemas/bulk_error' + - type: object + properties: + error: + type: string + nullable: true + message: + type: string + nullable: true + data: + type: object + nullable: true + '401': + description: Unauthorized request + content: + application/json: + schema: + $ref: '#/components/schemas/401' + '403': + description: Forbidden + content: + application/json: + schema: + $ref: '#/components/schemas/403' /admin/corporate_card_transactions/unassign: post: tags: diff --git a/src/admin/openapi.yaml b/src/admin/openapi.yaml index 2c705beca..5fc3f7fee 100644 --- a/src/admin/openapi.yaml +++ b/src/admin/openapi.yaml @@ -323,6 +323,8 @@ paths: $ref: paths/admin@corporate_card_transactions@assign.yaml /admin/corporate_card_transactions/assign/bulk: $ref: paths/admin@corporate_card_transactions@assign@bulk.yaml + /admin/corporate_card_transactions/reassign/bulk: + $ref: paths/admin@corporate_card_transactions@reassign@bulk.yaml /admin/corporate_card_transactions/unassign: $ref: paths/admin@corporate_card_transactions@unassign.yaml # /admin/corporate_card_transactions/unassign/bulk: diff --git a/src/admin/paths/admin@corporate_card_transactions@reassign@bulk.yaml b/src/admin/paths/admin@corporate_card_transactions@reassign@bulk.yaml new file mode 100644 index 000000000..21c0e9fb7 --- /dev/null +++ b/src/admin/paths/admin@corporate_card_transactions@reassign@bulk.yaml @@ -0,0 +1,53 @@ +post: + tags: + - Corporate Card Transactions + summary: Bulk reassign corporate card transactions + description: | + Reassign corporate card transactions to users in bulk. + operationId: corporate_card_transactions_reassign_bulk + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + data: + type: array + items: + $ref: '../../components/schemas/corporate_card_transaction.yaml#/corporate_card_transaction_reassign_in' + required: + - data + responses: + '200': + description: OK + '400': + description: Bad request + content: + application/json: + schema: + oneOf: + - $ref: '../../components/schemas/bulk_error.yaml' + - type: object + properties: + error: + type: string + nullable: true + message: + type: string + nullable: true + data: + type: object + nullable: true + '401': + description: Unauthorized request + content: + application/json: + schema: + $ref: '../../components/schemas/401.yaml' + '403': + description: Forbidden + content: + application/json: + schema: + $ref: '../../components/schemas/403.yaml' diff --git a/src/components/schemas/corporate_card_transaction.yaml b/src/components/schemas/corporate_card_transaction.yaml index 4612f7606..870176807 100644 --- a/src/components/schemas/corporate_card_transaction.yaml +++ b/src/components/schemas/corporate_card_transaction.yaml @@ -2411,3 +2411,19 @@ corporate_card_transactions_delete_in: example: btxn123453 required: - id + +corporate_card_transaction_reassign_in: + type: object + properties: + id: + allOf: + - $ref: './fields.yaml#/id_string' + example: btxnwownwrng + user_id: + type: string + description: | + The unique id of an user to whom the card transaction should be reassigned. + example: usge49ielgel + required: + - id + - user_id