Skip to content

Add a convenience GET /api/v1/faults endpoint #97

@mfaferek93

Description

@mfaferek93

Summary

Add a convenience GET /api/v1/faults endpoint that returns all faults across the system without requiring iteration over individual components.

Currently, to get all faults, clients must:

  1. GET /api/v1/components to list all components
  2. GET /api/v1/components/{id}/faults for each component

This is inefficient for dashboards and monitoring tools that need a complete system health view.


Proposed solution (optional)

Add GET /api/v1/faults endpoint that:

  • Returns all faults from all sources in a single request
  • Supports ?status= query parameter for filtering (pending, confirmed, cleared, all)
  • Default returns pending + confirmed faults (active issues)

Response structure:

{
  "faults": [...],
  "count": 5
}

Additional context (optional)

  • This is a convenience API extension beyond the per-component fault endpoints
  • Primary use case: FaultsPanel component in Web UI

Metadata

Metadata

Assignees

Labels

enhancementNew feature or request

Projects

No projects

Relationships

None yet

Development

No branches or pull requests

Issue actions