Hub v0.12.5

[pbrassel]

Summary by CodeRabbit

• New Features
  • Added consistent camelCase field handling for authentication resources.
• Documentation
  • Expanded README badges and updated examples to reflect camelCase response fields.
  • Added the changelog to the documentation navigation.
  • Updated authentication setup guidance and optional-field examples.
• Bug Fixes
  • Role retrieval is now validated as a standard passing scenario.
• Chores
  • Updated the test environment to use Pytest Hub version 0.12.5.

[coderabbitai]

Warning

Review limit reached

@pbrassel, you've reached your PR review limit, so we couldn't start this review.

Next review available in: 50 minutes

Enable usage-based reviews in Billing to review now. Otherwise, wait until the next included review is available.
You're only billed for reviews past your plan's rate limits ($0.25/file).

How can I continue?

After more reviews become available, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

To avoid repeated limits, reduce automatic review volume by pausing incremental auto-reviews earlier, using label-based review opt-in, excluding WIP or generated PR titles, or requesting reviews manually when the PR is ready. If your team needs uninterrupted high-volume reviews, an organization admin can enable usage-based reviews.

How do review limits work?

CodeRabbit enforces per-developer PR review limits for each organization. Most developers receive the normal plan review availability.

For paid Pro and Pro+ PR reviews, CodeRabbit uses adaptive limits for sustained high-volume activity. When a developer's recent PR review activity reaches the 95th percentile or higher among CodeRabbit users, additional reviews become available more gradually as earlier reviews age out of the rolling window.

Please refer docs for additional details.

Review details

⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro Plus

Run ID: 2a0df6ca-0cdd-4a6c-b22f-2af5bf6a3509

📥 Commits

Reviewing files that changed from the base of the PR and between ca60dfc and 85a5423.

📒 Files selected for processing (1)

• docs/user_guide.rst

📝 Walkthrough

Walkthrough

Auth client Pydantic models now use shared camelCase aliasing and name-aware serialization. Documentation examples reflect the API field format, authentication options, and optional fields. Changelog navigation, project badges, test execution, and the test Hub version are updated.

Changes

Auth client and documentation

Layer / File(s)	Summary
Standardize auth model serialization flame_hub/_auth_client.py, .env.test, tests/test_auth.py	Auth models inherit from AuthBaseModel with camelCase aliasing; the roles test is enabled and the test Hub version is updated.
Align usage examples with auth API fields README.md, docs/user_guide.rst	Examples use camelCase realm fields, document StaticAuth, and request a robot email field.
Publish project documentation README.md, docs/changelog.rst, docs/index.rst	Project badges are expanded, the changelog is included with MyST parsing, and its navigation entry is added.

Estimated code review effort: 2 (Simple) | ~10 minutes

Possibly related PRs

• PrivateAIM/hub-python-client#100: Updates the same auth client Pydantic model area, including client CRUD models.
• PrivateAIM/hub-python-client#117: Relates directly to camelCase authup API field and parameter handling.

🚥 Pre-merge checks | ✅ 5

✅ Passed checks (5 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title check	✅ Passed	The title matches the release/version bump theme and is clearly related to the changes in this PR.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check	✅ Passed	Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check	✅ Passed	Check skipped because no linked issues were found for this pull request.

✨ Finishing Touches

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Commit unit tests in branch hub-v0.12.5

---

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.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

_{Comment @coderabbitai help to get the list of available commands.}

[coderabbitai]

Actionable comments posted: 2

🤖 Prompt for all review comments with AI agents

Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Inline comments:
In `@docs/user_guide.rst`:
- Around line 17-19: Update the authentication guidance near PasswordAuth,
ClientAuth, and StaticAuth to remove the stale “two main authentication schemes”
and “previous two” wording, leaving the documentation consistent with all three
supported schemes.
- Around line 219-231: Align the optional-field example using
auth_client.find_robots with the get_field_names(Robot) documentation: update
the supported-field assertion/documentation to include email if it is valid, or
remove/revert the fields="email" example if it is not supported. Ensure the
guide presents one consistent Robot field contract.

🪄 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: defaults

Review profile: CHILL

Plan: Pro Plus

Run ID: fea00a45-25eb-46b8-9316-ff78aed3622f

📥 Commits

Reviewing files that changed from the base of the PR and between 1783ede and ca60dfc.

📒 Files selected for processing (7)

• .env.test
• README.md
• docs/changelog.rst
• docs/index.rst
• docs/user_guide.rst
• flame_hub/_auth_client.py
• tests/test_auth.py

💤 Files with no reviewable changes (1)

• tests/test_auth.py