-
Notifications
You must be signed in to change notification settings - Fork 46
Open
Labels
enhancementNew feature or requestNew feature or request
Description
Problem Statement
The current sandbox proxy responses lack a consistent structure making integration difficult. The different endpoints return different response structures which complicates client-side handling.
Proposed Solution
Standardize all API responses to follow consistent structure as described in the new interface response body specification:
- A standardized response wrapper (BaseResponse with status, message, error fields)
- Consistent result objects containing code and failure_reason
- Proper inheritance hierarchy for all response type classes
Changes Made
- Created specification document at
docs/_specs/response/interface_response_body_spec.md - Refactored response classes in
rock/actions/sandbox/response.pyto inherit fromSandboxResponse - Added
codeandfailure_reasonfields to all response types - Updated API endpoint responses to use the
RockResponse[SpecificResponseType]wrapper - Added tests in
tests/unit/test_sandbox_response.pyto validate compliance - Moved interface specification file to proper location for documentation organization
Benefits
- Consistent API response format makes integration easier
- Clear documentation of response structures
- Better error handling with standardized error fields
- Improved API predictability
Component Affected
- Sandbox
- Actions
- SDK & API
- Documentation & Examples
Reactions are currently unavailable
Metadata
Metadata
Assignees
Labels
enhancementNew feature or requestNew feature or request