chore(docs): remove VOLUME_STORAGE_PATH, fix stale refs, expand REST examples#88
Conversation
|
Warning Rate limit exceeded
Your organization is not enrolled in usage-based pricing. Contact your admin to enable usage-based pricing to continue reviews beyond the rate limit, or try again in 4 minutes and 58 seconds. ⌛ How to resolve this issue?After the wait time has elapsed, a review can be triggered using the We recommend that you space out your commits to avoid hitting the rate limit. 🚦 How do rate limits work?CodeRabbit enforces hourly rate limits for each developer per organization. Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout. Please see our FAQ for further information. ℹ️ Review info⚙️ Run configurationConfiguration used: Path: .coderabbit.yaml Review profile: CHILL Plan: Pro Run ID: 📒 Files selected for processing (4)
WalkthroughUpdated AI instruction doc to Rocket 0.5.1, added Swagger UI reference and clarified STORAGE_PATH in README, expanded REST client test scenarios for players/squad number success and error cases, and simplified the entrypoint script to use Changes
Estimated code review effort🎯 3 (Moderate) | ⏱️ ~20 minutes Possibly related PRs
🚥 Pre-merge checks | ✅ 2✅ Passed checks (2 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
11af501 to
08d9454
Compare
nanotaboada
changed the title
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
🧹 Nitpick comments (1)
rest/players.rest (1)
35-36: Optional DRY cleanup: use declared variables inside JSON bodies.You already define
@newSquadNumber/@existingSquadNumber; reusing them in payloads would reduce drift risk when these test values change.♻️ Example refactor
- "squadNumber": 27, + "squadNumber": {{newSquadNumber}}, ... - "squadNumber": 23, + "squadNumber": {{existingSquadNumber}},Also applies to: 56-57, 120-121, 140-141, 160-161
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@rest/players.rest` around lines 35 - 36, Replace hard-coded squadNumber literals in the JSON request bodies with the already-declared test variables (`@newSquadNumber` and `@existingSquadNumber`); specifically update the payloads that currently contain "squadNumber": 27 (and similar occurrences) to reference the appropriate variable so the create/update test bodies use `@newSquadNumber` or `@existingSquadNumber` instead of magic numbers, reducing drift when test values change.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In `@scripts/entrypoint.sh`:
- Around line 12-14: Add a POSIX-safe default for STORAGE_PATH so the entrypoint
and Rust app use the same fallback: before the mkdir -p "$(dirname
"$STORAGE_PATH")" and the if [ ! -f "$STORAGE_PATH" ] checks, set STORAGE_PATH
to a default (for example storage/players-sqlite3.db) when empty using POSIX
parameter expansion (e.g.,
STORAGE_PATH="${STORAGE_PATH:-storage/players-sqlite3.db}"), or apply the same
expansion inline in the existing commands to ensure both mkdir -p "$(dirname
"$STORAGE_PATH")" and the file existence test use the fallback value.
---
Nitpick comments:
In `@rest/players.rest`:
- Around line 35-36: Replace hard-coded squadNumber literals in the JSON request
bodies with the already-declared test variables (`@newSquadNumber` and
`@existingSquadNumber`); specifically update the payloads that currently contain
"squadNumber": 27 (and similar occurrences) to reference the appropriate
variable so the create/update test bodies use `@newSquadNumber` or
`@existingSquadNumber` instead of magic numbers, reducing drift when test values
change.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Path: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
Run ID: 68b12ed0-0524-4213-be0c-f4eb2d0e9b88
📒 Files selected for processing (4)
.github/copilot-instructions.mdREADME.mdrest/players.restscripts/entrypoint.sh
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## master #88 +/- ##
=======================================
Coverage 84.33% 84.33%
=======================================
Files 6 6
Lines 166 166
=======================================
Hits 140 140
Misses 26 26 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
…examples - Remove redundant VOLUME_STORAGE_PATH alias in entrypoint.sh; use $STORAGE_PATH directly with a POSIX-safe fallback matching the Rust app's own default - Clarify STORAGE_PATH defaults in README (container vs. local dev) - Add Swagger UI access endpoint to README - Update Rocket version from 0.5 to 0.5.1 in copilot-instructions.md - Expand rest/players.rest with existing/nonexistent/unknown naming convention, missing 404/409 cases, ordering comments, and variable-driven request bodies Co-authored-by: Claude Sonnet 4.6 <noreply@anthropic.com>
e4c25e1 to
7ed1f0a
Compare
1 participant
Summary
VOLUME_STORAGE_PATHlocal variable fromentrypoint.sh— it was an unreachable fallback alias for$STORAGE_PATH, which is always set via the DockerfileENVdirectiveREADME.mdenv var default clarified (container vs. local dev), Swagger UI access endpoint added,copilot-instructions.mdversion updated fromRocket 0.5toRocket 0.5.1rest/players.restwithexisting/nonexistent/unknownnaming convention, additional variables, all missing 404/409 cases, and ordering comments where sequential execution is requiredTest plan
entrypoint.shworks correctly in container (docker compose up)rest/players.restreturn the documented status codes when run top-to-bottom🤖 Generated with Claude Code
Summary by CodeRabbit
Documentation
Tests