Skip to content

Commit eb8b547

Browse files
committed
feat(express): enable API docs for ping endpoint
Add express_entry.ts to control OpenAPI doc generation. Starting with ping endpoint only to validate the pipeline before adding more. WP-7280 TICKET: WP-7280
1 parent 16c89b4 commit eb8b547

2 files changed

Lines changed: 431 additions & 0 deletions

File tree

modules/express/src/typedRoutes/api/common/ping.ts

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,18 @@ import { BitgoExpressError } from '../../schemas/error';
55
/**
66
* Ping
77
*
8+
* Health check endpoint for BitGo Express. Use this endpoint to verify that the
9+
* Express server is running and responsive before making other API calls.
10+
*
11+
* Common use cases:
12+
* - Load balancer health checks
13+
* - Container orchestration liveness probes (Kubernetes, ECS)
14+
* - Monitoring and alerting systems
15+
* - Pre-flight connectivity validation from client applications
16+
*
17+
* This endpoint requires no authentication and returns an empty 200 response
18+
* when the service is operational.
19+
*
820
* @operationId express.ping
921
* @tag express
1022
*/

0 commit comments

Comments
 (0)