Skip to content

API.md

Latest commit

 

History

History
62 lines (52 loc) · 2.96 KB

API.md

File metadata and controls

62 lines (52 loc) · 2.96 KB

RadioForge API Documentation

📚 Interactive API Documentation

Access the interactive API documentation:

The Swagger UI provides:

  • ✅ Interactive API Testing - Try all endpoints directly from the browser
  • ✅ Request/Response Schemas - See exact data structures for all endpoints
  • ✅ Parameter Documentation - Detailed descriptions for all parameters
  • ✅ Response Codes - Complete list of possible responses
  • ✅ Try It Out - Execute API calls and see real responses

Features:

  • All endpoints are fully documented with descriptions
  • Request/response examples for each endpoint
  • Parameter validation and type information
  • Organized by tags (Test Cases, Test Executions, Test Runner, etc.)

🔌 API Endpoints

Test Cases

  • GET /api/test-cases - Get all test cases
  • GET /api/test-cases/{id} - Get test case by ID
  • GET /api/test-cases/by-test-case-id/{testCaseId} - Get by test case ID
  • GET /api/test-cases/technology/{technology} - Get by technology
  • GET /api/test-cases/category/{category} - Get by category
  • GET /api/test-cases/enabled - Get enabled test cases
  • GET /api/test-cases/enabled/technology/{technology} - Get enabled by technology
  • POST /api/test-cases - Create new test case
  • PUT /api/test-cases/{id} - Update test case
  • DELETE /api/test-cases/{id} - Delete test case
  • POST /api/test-cases/{id}/enable - Enable a test case
  • POST /api/test-cases/{id}/disable - Disable a test case

Test Execution

  • GET /api/test-executions - Get all executions
  • GET /api/test-executions/{id} - Get execution by ID
  • GET /api/test-executions/test-case/{testCaseId} - Get by test case
  • GET /api/test-executions/status/{status} - Get by status
  • GET /api/test-executions/technology/{technology} - Get by technology
  • GET /api/test-executions/date-range?start={start}&end={end} - Get by date range
  • GET /api/test-executions/recent/test-case/{testCaseId} - Get recent executions
  • POST /api/test-executions - Create new execution
  • PUT /api/test-executions/{id} - Update execution
  • POST /api/test-executions/{id}/complete?status={status}&errorMessage={msg} - Complete execution
  • GET /api/test-executions/stats/count?status={status} - Count by status

Test Runner

  • POST /api/test-runner/run/{testCaseId} - Run a specific test case
  • POST /api/test-runner/run/id/{id} - Run by database ID
  • POST /api/test-runner/run/technology/{technology} - Run all tests for a technology
  • POST /api/test-runner/run/category/{category} - Run all tests for a category
  • POST /api/test-runner/run/all - Run all enabled tests

Test Reports

  • GET /api/reports/test-case/{testCaseId} - Get report for a test case
  • GET /api/reports/execution/{executionId} - Get report for an execution

💡 Tip: Use the Swagger UI for interactive API exploration and testing!