Skip to content

Update SearchRikishi API docs after bug fix #20

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
matheuscscp merged 1 commit into from
Dec 9, 2025
Merged

Update SearchRikishi API docs after bug fix #20

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
3 changes: 0 additions & 3 deletions search_rikishi.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,9 +9,6 @@ import (
// SearchRikishiAPI defines the methods available for searching rikishi.
type SearchRikishiAPI interface {
// SearchRikishi calls the GET /api/rikishis endpoint.
//
// Documented bugs:
// - The API always returns the overall total number of rikishi in the database, instead of the total number of matching results like in the other endpoints.
SearchRikishi(ctx context.Context, req SearchRikishiRequest) (*SearchRikishiResponse, error)
}

Expand Down
4 changes: 1 addition & 3 deletions tests/integration/search_rikishi_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,11 +27,9 @@ func TestIntegration_SearchRikishi(t *testing.T) {
g.Expect(resp).ToNot(BeNil())
g.Expect(resp.Limit).To(Equal(1))
g.Expect(resp.Skip).To(Equal(0))
g.Expect(resp.Total).To(Equal(1))
g.Expect(resp.Rikishi).To(HaveLen(1))

// Bug: The total is always the overall total amount of rikishi in the database.
g.Expect(resp.Total).To(BeNumerically(">", 9000))

hakuho := resp.Rikishi[0]
g.Expect(hakuho.ShikonaEnglish).To(Equal("Hakuho Sho"))
g.Expect(hakuho.Heya).To(Equal("Miyagino"))
Expand Down