Skip to content

refactor: api response schema #650

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
alexluong merged 14 commits into from
Jan 19, 2026
Merged

refactor: api response schema #650

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
14 commits
Select commit Hold shift + click to select a range
e42e749
refactor: add shared pagination helpers for Hookdeck API alignment
alexluong Jan 19, 2026
3b086b5
refactor: extend pagination helpers with full Hookdeck query operators
alexluong Jan 19, 2026
caddeb7
refactor: simplify pagination helpers to only support gte/lte
alexluong Jan 19, 2026
7b8726a
refactor: update error response format to Hookdeck style
alexluong Jan 19, 2026
06da6bc
refactor: update list endpoints to Hookdeck response format
alexluong Jan 19, 2026
a532e61
refactor: remove created_at filtering from ListTenant
alexluong Jan 19, 2026
fb4565d
docs: update OpenAPI spec and code for new pagination format
alexluong Jan 19, 2026
d6deaf8
test: update e2e tests for new API format
alexluong Jan 19, 2026
8571588
feat: add GT/LT operator support to time filters
alexluong Jan 19, 2026
0f3b5b1
test: add cursor pagination with time filter tests
alexluong Jan 19, 2026
eb09c58
docs: add time field to PublishRequest schema
alexluong Jan 19, 2026
c57378c
feat: reject requests with both next and prev cursors
alexluong Jan 19, 2026
7f4d69e
fix: return literal ["*"] for tenant topics with wildcard destination
alexluong Jan 19, 2026
f2935ae
docs: improve date format error message with examples
alexluong Jan 19, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
56 changes: 30 additions & 26 deletions cmd/e2e/api_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -534,9 +534,9 @@ func (suite *basicSuite) TestListTenantsAPI() {

body, ok := resp.Body.(map[string]interface{})
require.True(t, ok, "response should be a map")
data, ok := body["data"].([]interface{})
require.True(t, ok, "data should be an array")
assert.GreaterOrEqual(t, len(data), 3, "should have at least 3 tenants")
models, ok := body["models"].([]interface{})
require.True(t, ok, "models should be an array")
assert.GreaterOrEqual(t, len(models), 3, "should have at least 3 tenants")
})

// Test list with limit
Expand All @@ -550,9 +550,9 @@ func (suite *basicSuite) TestListTenantsAPI() {

body, ok := resp.Body.(map[string]interface{})
require.True(t, ok, "response should be a map")
data, ok := body["data"].([]interface{})
require.True(t, ok, "data should be an array")
assert.Equal(t, 2, len(data), "should have exactly 2 tenants")
models, ok := body["models"].([]interface{})
require.True(t, ok, "models should be an array")
assert.Equal(t, 2, len(models), "should have exactly 2 tenants")
})

// Test invalid limit
Expand All @@ -577,11 +577,12 @@ func (suite *basicSuite) TestListTenantsAPI() {

body, ok := resp.Body.(map[string]interface{})
require.True(t, ok, "response should be a map")
data, ok := body["data"].([]interface{})
require.True(t, ok, "data should be an array")
assert.Equal(t, 2, len(data), "page 1 should have 2 tenants")
models, ok := body["models"].([]interface{})
require.True(t, ok, "models should be an array")
assert.Equal(t, 2, len(models), "page 1 should have 2 tenants")

next, _ := body["next"].(string)
pagination, _ := body["pagination"].(map[string]interface{})
next, _ := pagination["next"].(string)
require.NotEmpty(t, next, "should have next cursor")

// Get second page using next cursor
Expand All @@ -594,11 +595,12 @@ func (suite *basicSuite) TestListTenantsAPI() {

body, ok = resp.Body.(map[string]interface{})
require.True(t, ok, "response should be a map")
data, ok = body["data"].([]interface{})
require.True(t, ok, "data should be an array")
assert.GreaterOrEqual(t, len(data), 1, "page 2 should have at least 1 tenant")
models, ok = body["models"].([]interface{})
require.True(t, ok, "models should be an array")
assert.GreaterOrEqual(t, len(models), 1, "page 2 should have at least 1 tenant")

prev, _ := body["prev"].(string)
pagination, _ = body["pagination"].(map[string]interface{})
prev, _ := pagination["prev"].(string)
assert.NotEmpty(t, prev, "page 2 should have prev cursor")
})

Expand All @@ -613,7 +615,8 @@ func (suite *basicSuite) TestListTenantsAPI() {
body, ok := resp.Body.(map[string]interface{})
require.True(t, ok)

next, _ := body["next"].(string)
pagination, _ := body["pagination"].(map[string]interface{})
next, _ := pagination["next"].(string)
require.NotEmpty(t, next, "should have next cursor")

// Go to page 2
Expand All @@ -625,7 +628,8 @@ func (suite *basicSuite) TestListTenantsAPI() {
body, ok = resp.Body.(map[string]interface{})
require.True(t, ok)

prev, _ := body["prev"].(string)
pagination, _ = body["pagination"].(map[string]interface{})
prev, _ := pagination["prev"].(string)
require.NotEmpty(t, prev, "page 2 should have prev cursor")

// Using prev cursor returns items with newer timestamps (keyset pagination)
Expand All @@ -639,9 +643,9 @@ func (suite *basicSuite) TestListTenantsAPI() {

body, ok = resp.Body.(map[string]interface{})
require.True(t, ok, "response should be a map")
data, ok := body["data"].([]interface{})
require.True(t, ok, "data should be an array")
assert.NotEmpty(t, data, "prev cursor should return items")
models, ok := body["models"].([]interface{})
require.True(t, ok, "models should be an array")
assert.NotEmpty(t, models, "prev cursor should return items")
})

// Cleanup
Expand Down Expand Up @@ -727,9 +731,9 @@ func (suite *basicSuite) TestDestinationsAPI() {
StatusCode: http.StatusUnprocessableEntity,
Body: map[string]interface{}{
"message": "validation error",
"data": map[string]interface{}{
"topics": "required",
"type": "required",
"data": []interface{}{
"type is required",
"topics is required",
},
},
},
Expand Down Expand Up @@ -795,8 +799,8 @@ func (suite *basicSuite) TestDestinationsAPI() {
StatusCode: http.StatusUnprocessableEntity,
Body: map[string]interface{}{
"message": "validation error",
"data": map[string]interface{}{
"config.url": "required",
"data": []interface{}{
"config.url is required",
},
},
},
Expand Down Expand Up @@ -1253,8 +1257,8 @@ func (suite *basicSuite) TestDestinationsAPI() {
StatusCode: http.StatusUnprocessableEntity,
Body: map[string]interface{}{
"message": "validation error",
"data": map[string]interface{}{
"config.url": "required",
"data": []interface{}{
"config.url is required",
},
},
},
Expand Down
28 changes: 14 additions & 14 deletions cmd/e2e/destwebhook_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -530,8 +530,8 @@ func (suite *basicSuite) TestDestwebhookTenantSecretManagement() {
StatusCode: http.StatusUnprocessableEntity,
Body: map[string]interface{}{
"message": "validation error",
"data": map[string]interface{}{
"credentials.secret": "forbidden",
"data": []interface{}{
"credentials.secret failed forbidden validation",
},
},
},
Expand Down Expand Up @@ -593,8 +593,8 @@ func (suite *basicSuite) TestDestwebhookTenantSecretManagement() {
StatusCode: http.StatusUnprocessableEntity,
Body: map[string]interface{}{
"message": "validation error",
"data": map[string]interface{}{
"credentials.secret": "forbidden",
"data": []interface{}{
"credentials.secret failed forbidden validation",
},
},
},
Expand All @@ -616,8 +616,8 @@ func (suite *basicSuite) TestDestwebhookTenantSecretManagement() {
StatusCode: http.StatusUnprocessableEntity,
Body: map[string]interface{}{
"message": "validation error",
"data": map[string]interface{}{
"credentials.previous_secret": "forbidden",
"data": []interface{}{
"credentials.previous_secret failed forbidden validation",
},
},
},
Expand All @@ -639,8 +639,8 @@ func (suite *basicSuite) TestDestwebhookTenantSecretManagement() {
StatusCode: http.StatusUnprocessableEntity,
Body: map[string]interface{}{
"message": "validation error",
"data": map[string]interface{}{
"credentials.previous_secret_invalid_at": "forbidden",
"data": []interface{}{
"credentials.previous_secret_invalid_at failed forbidden validation",
},
},
},
Expand Down Expand Up @@ -865,8 +865,8 @@ func (suite *basicSuite) TestDestwebhookAdminSecretManagement() {
StatusCode: http.StatusUnprocessableEntity,
Body: map[string]interface{}{
"message": "validation error",
"data": map[string]interface{}{
"credentials.rotate_secret": "invalid",
"data": []interface{}{
"credentials.rotate_secret failed invalid validation",
},
},
},
Expand Down Expand Up @@ -932,8 +932,8 @@ func (suite *basicSuite) TestDestwebhookAdminSecretManagement() {
StatusCode: http.StatusUnprocessableEntity,
Body: map[string]interface{}{
"message": "validation error",
"data": map[string]interface{}{
"credentials.previous_secret_invalid_at": "pattern",
"data": []interface{}{
"credentials.previous_secret_invalid_at failed pattern validation",
},
},
},
Expand Down Expand Up @@ -1082,8 +1082,8 @@ func (suite *basicSuite) TestDestwebhookAdminSecretManagement() {
StatusCode: http.StatusUnprocessableEntity,
Body: map[string]interface{}{
"message": "validation error",
"data": map[string]interface{}{
"credentials.secret": "required",
"data": []interface{}{
"credentials.secret is required",
},
},
},
Expand Down
Loading