Skip to content

fix: correct enum class name in updateOrganizationSessionPolicy Javadoc#60

Open
srinivaskarre-sk wants to merge 1 commit into
mainfrom
fix/session-policy-javadoc-typo
Open

fix: correct enum class name in updateOrganizationSessionPolicy Javadoc#60
srinivaskarre-sk wants to merge 1 commit into
mainfrom
fix/session-policy-javadoc-typo

Conversation

@srinivaskarre-sk

@srinivaskarre-sk srinivaskarre-sk commented May 13, 2026

Copy link
Copy Markdown
Contributor

Summary

  • Fixes a typo in the updateOrganizationSessionPolicy Javadoc: SessionPolicySource.APPLICATIONSessionPolicyType.APPLICATION
  • SessionPolicySource does not exist; the correct class is SessionPolicyType

Test plan

  • No behaviour change — doc comment fix only

Summary by CodeRabbit

  • Documentation
    • Updated session policy documentation for accuracy.

Review Change Stack

@coderabbitai

coderabbitai Bot commented May 13, 2026

Copy link
Copy Markdown

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: 99a948f0-7d1e-48ce-8907-97a5e0a39f92

📥 Commits

Reviewing files that changed from the base of the PR and between 9d24257 and 810762d.

📒 Files selected for processing (1)
  • src/main/java/com/scalekit/api/impl/ScalekitOrganizationClient.java

Walkthrough

A single-line Javadoc correction in ScalekitOrganizationClient updates the parameter documentation for updateOrganizationSessionPolicy(...) to reference the correct type: SessionPolicyType.APPLICATION instead of the previously incorrect SessionPolicySource.APPLICATION.

Changes

Javadoc Correction

Layer / File(s) Summary
SessionPolicyType javadoc reference update
src/main/java/com/scalekit/api/impl/ScalekitOrganizationClient.java
Javadoc @param policy text corrected to reference SessionPolicyType.APPLICATION for reverting to application defaults, replacing the incorrect SessionPolicySource.APPLICATION reference.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

Poem

🐰 A typo in the docs, a simple fix,
SessionPolicyType—no more mix-ups, no tricks!
Clear as carrots, the path now gleams,
Small but mighty, these documentation dreams. ✨

🚥 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 accurately reflects the main change: correcting an incorrect enum class name (SessionPolicySource to SessionPolicyType) in the Javadoc of the updateOrganizationSessionPolicy method.
Docstring Coverage ✅ Passed Docstring coverage is 100.00% which is sufficient. The required threshold is 80.00%.
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.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
📝 Generate docstrings
  • Create stacked PR
  • Commit on current branch
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch fix/session-policy-javadoc-typo

Comment @coderabbitai help to get the list of available commands and usage tips.

@srinivaskarre-sk

Copy link
Copy Markdown
Contributor Author

@coderabbitai approve

@coderabbitai

coderabbitai Bot commented May 25, 2026

Copy link
Copy Markdown
✅ Actions performed

Comments resolved and changes approved.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants