synapsecns/sanguine

View on GitHub
packages/rfq-indexer/api/src/routes/transactionIdRoute.ts

Summary

Maintainability
A
0 mins
Test Coverage
import express from 'express'

import { getTransactionById } from '../controllers/transactionIdController'

const router = express.Router()

/**
 * @openapi
 * /transaction-id/{transactionId}:
 *   get:
 *     summary: Get transaction details by ID
 *     description: Retrieves details of a specific transaction by its ID
 *     parameters:
 *       - in: path
 *         name: transactionId
 *         required: true
 *         schema:
 *           type: string
 *         description: The ID of the transaction to retrieve
 *     responses:
 *       200:
 *         description: Successful response
 *         content:
 *           application/json:
 *             schema:
 *               type: object
 *               properties:
 *                 Bridge:
 *                   type: object
 *                   description: General transaction fields
 *                 BridgeRequest:
 *                   type: object
 *                   description: Deposit information
 *                 BridgeRelay:
 *                   type: object
 *                   description: Relay information
 *                 BridgeRefund:
 *                   type: object
 *                   description: Refund information
 *                 BridgeProof:
 *                   type: object
 *                   description: Proof information (if available)
 *                 BridgeClaim:
 *                   type: object
 *                   description: Claim information (if available)
 *                 BridgeDispute:
 *                   type: object
 *                   description: Dispute information (if available)
 *       404:
 *         description: Transaction not found
 *         content:
 *           application/json:
 *             schema:
 *               type: object
 *               properties:
 *                 message:
 *                   type: string
 */
router.get('/:transactionId', getTransactionById)

export default router