fix: change get space statistics api interface #3499
+8
−8
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
nameless-mc
requested review from
chihiro-adachi,
Copilot and
tasshi-me
and removed request for
a team
Copilot finished reviewing on behalf of
nameless-mc
November 19, 2025 02:18
Contributor
There was a problem hiding this comment.
Pull Request Overview
This PR renames SpaceClient.getSpacesStatistics to SpaceClient.getStatistics to align with the existing AppClient.getStatistics method naming convention. Since the client name already indicates the scope (Space), the redundant "Spaces" qualifier in the method name is removed for consistency.
- Renamed method from
getSpacesStatisticstogetStatisticsinSpaceClient - Updated all test cases to use the new method name
- Updated documentation to reflect the method name change
Reviewed Changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
| packages/rest-api-client/src/client/SpaceClient.ts | Renamed the public method getSpacesStatistics to getStatistics for consistency with AppClient |
| packages/rest-api-client/src/client/tests/SpaceClient.test.ts | Updated test suite describe block and all method calls to use the new getStatistics name |
| packages/rest-api-client/docs/space.md | Updated documentation table of contents and section header to reference the new method name getStatistics |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Why
To align the interface with
AppClient.getStatistics. Currently,AppClientuses the method namegetStatistics, whileSpaceClientuses the redundant namegetSpacesStatistics. Since the scope is already clear from the client name, there's no need to includeSpacesin the method name.What
SpaceClient.getSpacesStatisticstoSpaceClient.getStatisticspackages/rest-api-client/docs/space.md)How to test
Checklist
pnpm lintandpnpm teston the root directory.