apache / apache/hugegraph

[Feature] Unify REST API response format for server,pd and store modules

Open
#2,975 1 comment 0 reactions 1 assignee Claimed by @BrandaoFelipe View on GitHub
feature help wanted
Dominant language
Java
Stars
3.2k
Forks
636
Avg merge
3d 11h
Merged PRs (30d)
14

Description

### Feature Description (功能描述)

Currently, the REST API responses in the server,pd and store modules lack a standardized format.

When a request fails (e.g., Raft group not found, store heartbeat timeout), the error message is often missing or buried in logs rather than being returned in a clear, actionable format to the user.

An example response format is as follows
```json
{
"code": 200,
"message": "success", // hint for user
"data": { ... },
"status": "OK"
}
```

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.