Files
CurrenciCombo/docs/POSTMAN_COLLECTION.md
defiQUG f52313e7c6 Enhance ComboHandler and orchestrator functionality with access control and error handling improvements
- Added AccessControl to ComboHandler for role-based access management.
- Implemented gas estimation for plan execution and improved gas limit checks.
- Updated execution and preparation methods to enforce step count limits and role restrictions.
- Enhanced error handling in orchestrator API endpoints with AppError for better validation feedback.
- Integrated request timeout middleware for improved request management.
- Updated Swagger documentation to reflect new API structure and parameters.
2025-11-05 17:55:48 -08:00

2.7 KiB

Postman Collection

Import Instructions

  1. Open Postman
  2. Click "Import"
  3. Select "Raw text"
  4. Paste the JSON below

Collection JSON

{
  "info": {
    "name": "ISO-20022 Combo Flow API",
    "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json"
  },
  "item": [
    {
      "name": "Plans",
      "item": [
        {
          "name": "Create Plan",
          "request": {
            "method": "POST",
            "header": [
              {
                "key": "Content-Type",
                "value": "application/json"
              },
              {
                "key": "X-API-Key",
                "value": "{{apiKey}}"
              }
            ],
            "body": {
              "mode": "raw",
              "raw": "{\n  \"creator\": \"user@example.com\",\n  \"steps\": [\n    {\n      \"type\": \"borrow\",\n      \"asset\": \"CBDC_USD\",\n      \"amount\": 100000\n    }\n  ]\n}"
            },
            "url": {
              "raw": "{{baseUrl}}/api/plans",
              "host": ["{{baseUrl}}"],
              "path": ["api", "plans"]
            }
          }
        },
        {
          "name": "Get Plan",
          "request": {
            "method": "GET",
            "header": [
              {
                "key": "X-API-Key",
                "value": "{{apiKey}}"
              }
            ],
            "url": {
              "raw": "{{baseUrl}}/api/plans/:planId",
              "host": ["{{baseUrl}}"],
              "path": ["api", "plans", ":planId"],
              "variable": [
                {
                  "key": "planId",
                  "value": ""
                }
              ]
            }
          }
        },
        {
          "name": "Execute Plan",
          "request": {
            "method": "POST",
            "header": [
              {
                "key": "X-API-Key",
                "value": "{{apiKey}}"
              }
            ],
            "url": {
              "raw": "{{baseUrl}}/api/plans/:planId/execute",
              "host": ["{{baseUrl}}"],
              "path": ["api", "plans", ":planId", "execute"]
            }
          }
        }
      ]
    },
    {
      "name": "Health",
      "item": [
        {
          "name": "Health Check",
          "request": {
            "method": "GET",
            "url": {
              "raw": "{{baseUrl}}/health",
              "host": ["{{baseUrl}}"],
              "path": ["health"]
            }
          }
        }
      ]
    }
  ],
  "variable": [
    {
      "key": "baseUrl",
      "value": "http://localhost:8080"
    },
    {
      "key": "apiKey",
      "value": ""
    }
  ]
}

Last Updated: 2025-01-15