Skip to content

Conversation

ewanharris
Copy link
Member

@ewanharris ewanharris commented Oct 7, 2025

Description

Cuts a release of the java sdk with header fixes and copies across some minor updates from the generated code

## v0.9.1

### [0.9.1](https://github.com/openfga/java-sdk/compare/v0.9.0...v0.9.1) (2025-10-07)

### Fixed

- Override `defaultHeaders` in `ClientConfiguration` to return correct type when using method (#226)
- Correctly handle options with no modelID set in `readAuthorizationModel` (#226)
- Include headers when converting from `ClientListRelationsOptions` to `ClientBatchCheckOptions` (#226)

References

Review Checklist

  • I have clicked on "allow edits by maintainers".
  • I have added documentation for new/changed functionality in this PR or in a PR to openfga.dev [Provide a link to any relevant PRs in the references section above]
  • The correct base branch is being used, if not main
  • I have added tests to validate that the change in functionality is working as expected

Summary by CodeRabbit

  • Bug Fixes
    • Correct return type for default headers when using a method.
    • Handle options with no model ID in readAuthorizationModel.
    • Preserve headers when converting list relations options to batch check options.
  • Documentation
    • Expanded guidance for BatchCheck (limits, SDK splitting) and Read (input structure, examples).
    • Updated README badges (X) and usage snippets to 0.9.1.
    • Added CHANGELOG entry for v0.9.1.
  • Chores
    • Bumped SDK/version identifiers to 0.9.1 (including user agent).
    • Reorganized and expanded example projects under a new examples/ structure.

@ewanharris ewanharris requested review from a team as code owners October 7, 2025 16:39
@ewanharris ewanharris changed the title chore: misc updates based on api doc changes and file changes release: v0.9.1 Oct 7, 2025
@codecov-commenter
Copy link

codecov-commenter commented Oct 7, 2025

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 35.97%. Comparing base (a84d17c) to head (be5e728).

Additional details and impacted files
@@            Coverage Diff            @@
##               main     #233   +/-   ##
=========================================
  Coverage     35.97%   35.97%           
  Complexity     1116     1116           
=========================================
  Files           187      187           
  Lines          7096     7096           
  Branches        806      806           
=========================================
  Hits           2553     2553           
  Misses         4438     4438           
  Partials        105      105           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

Copy link
Contributor

coderabbitai bot commented Oct 7, 2025

Walkthrough

Version bump to 0.9.1 across build and configuration files, repository example assets reorganized from example/ to examples/basic-examples/, documentation expanded for BatchCheck and Read APIs, CHANGELOG updated for v0.9.1, and README badges/links adjusted.

Changes

Cohort / File(s) Summary of Changes
Repository manifest and examples reorg
\.openapi-generator/FILES, examples/basic-examples/...*
Removed .github/dependabot.yaml and NOTICE.txt from generator manifest. Switched paths from example/... to examples/.... Added/organized example assets under examples/basic-examples (wrappers, settings, sources, resources).
Version bump to 0.9.1
build.gradle, publish.gradle, README.md, examples/basic-examples/build.gradle, src/main/java/dev/openfga/sdk/api/configuration/Configuration.java, src/test/java/dev/openfga/sdk/api/configuration/ConfigurationTest.java
Updated artifact/project versions from 0.9.0 to 0.9.1, including README dependency snippets. Updated Configuration.VERSION and default user agent; adjusted corresponding tests.
Docs and changelog updates
docs/OpenFgaApi.md, src/main/java/dev/openfga/sdk/api/OpenFgaApi.java, CHANGELOG.md, README.md
Expanded BatchCheck and Read API docs/Javadoc with clarifications and notes. Added v0.9.1 section to CHANGELOG and updated comparison links. Updated social badge and “X” references in README.

Sequence Diagram(s)

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Possibly related PRs

Suggested reviewers

  • jimmyjames
  • evansims

Pre-merge checks and finishing touches

✅ Passed checks (3 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title Check ✅ Passed The title “release: v0.9.1” succinctly and accurately conveys the primary change—a new SDK release with version bump to v0.9.1—without extraneous detail or vague language.
Docstring Coverage ✅ Passed No functions found in the changes. Docstring coverage check skipped.
✨ Finishing touches
  • 📝 Generate docstrings
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch release/java-v0.9.1

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

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

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 2

📜 Review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between a84d17c and be5e728.

📒 Files selected for processing (10)
  • .openapi-generator/FILES (1 hunks)
  • CHANGELOG.md (1 hunks)
  • README.md (5 hunks)
  • build.gradle (1 hunks)
  • docs/OpenFgaApi.md (4 hunks)
  • examples/basic-examples/build.gradle (1 hunks)
  • publish.gradle (1 hunks)
  • src/main/java/dev/openfga/sdk/api/OpenFgaApi.java (4 hunks)
  • src/main/java/dev/openfga/sdk/api/configuration/Configuration.java (1 hunks)
  • src/test/java/dev/openfga/sdk/api/configuration/ConfigurationTest.java (1 hunks)
🔇 Additional comments (11)
build.gradle (1)

22-22: LGTM! Version bump is correct.

The version update to 0.9.1 aligns with the release objectives and is consistent with other version references across the project.

examples/basic-examples/build.gradle (1)

26-26: LGTM! Dependency version is correctly updated.

The SDK dependency version matches the project version being released (0.9.1).

src/main/java/dev/openfga/sdk/api/configuration/Configuration.java (1)

33-36: LGTM! Version constants are correctly updated.

Both the VERSION constant and DEFAULT_USER_AGENT string have been updated consistently to reflect the 0.9.1 release.

src/test/java/dev/openfga/sdk/api/configuration/ConfigurationTest.java (1)

25-25: LGTM! Test expectation is correctly updated.

The test constant matches the updated DEFAULT_USER_AGENT value in the Configuration class.

publish.gradle (1)

9-9: LGTM! Maven publication version is correctly updated.

The POM version has been updated to 0.9.1, consistent with the project version.

CHANGELOG.md (1)

3-13: LGTM! Changelog is correctly updated.

The changelog properly documents the v0.9.1 release with:

  • Updated unreleased comparison URL
  • New v0.9.1 section dated 2025-10-07
  • Three fixed items that align with the PR description (all referencing #226)
README.md (4)

11-11: LGTM! Badge updated to reflect platform rename.

The badge has been correctly updated from Twitter to X, reflecting the platform's rebranding.


69-69: LGTM! Link text updated consistently.

The resources section now correctly references X instead of Twitter.


85-119: LGTM! All dependency version references are correctly updated.

Version 0.9.1 has been consistently applied across all package manager examples (Gradle Groovy, Gradle Kotlin, Maven, Ivy, SBT, and Leiningen).


303-303: LGTM! Formatting improvement.

The added blank line improves the document structure and readability.

.openapi-generator/FILES (1)

103-113: LGTM! Manifest correctly reflects project reorganization.

The manifest has been updated to reflect the reorganization of example assets from example/ to examples/basic-examples/, including a more complete set of example-related files (Gradle wrappers, settings, and source files).

@ewanharris ewanharris added this pull request to the merge queue Oct 7, 2025
Merged via the queue into main with commit 4c55350 Oct 7, 2025
25 checks passed
@ewanharris ewanharris deleted the release/java-v0.9.1 branch October 7, 2025 17:47
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.

3 participants