Skip to content

docs(jackson3): clarify domain mapping usage examples - #33

Merged
kazemek merged 1 commit into
mainfrom
docs/clarify-jackson3-mapping-examples
Aug 2, 2026
Merged

docs(jackson3): clarify domain mapping usage examples#33
kazemek merged 1 commit into
mainfrom
docs/clarify-jackson3-mapping-examples

Conversation

@kazemek

@kazemek kazemek commented Aug 2, 2026 •
edited by coderabbitai Bot
Loading

Copy link
Copy Markdown
Collaborator

Split map→write, bare resource, and collection into dedicated snippets, and demote IdentifierConverter to a brief note.

Summary by CodeRabbit

  • Documentation
    • Clarified minimal usage examples for domain-to-resource mapping, individual resource conversion, and collection conversion.
    • Documented that collection conversions produce a JsonApiDocument.
    • Explained default @JsonApiId string conversion and referenced IdentifierConverter for custom identifier formats.
    • Removed the outdated custom identifier-conversion code example.

@kazemek
docs(jackson3): clarify domain mapping usage examples
b9d9a6c 
Split map→write, bare resource, and collection into dedicated snippets,
and demote IdentifierConverter to a brief note.
@coderabbitai

coderabbitai Bot commented Aug 2, 2026 •
edited
Loading

Copy link
Copy Markdown

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro Plus

Run ID: 6e95aa10-9617-46e1-9866-9c6436024373

📥 Commits

Reviewing files that changed from the base of the PR and between b3c3f9c and b9d9a6c.

📒 Files selected for processing (1)
  • jsonapi-java-jackson3/README.md
📝 Walkthrough

Walkthrough

The Jackson 3 README now separates mapping examples for documents, bare resources, and collections. It also documents default @JsonApiId string conversion and references IdentifierConverter for custom formats.

Changes

Jackson 3 README documentation

Layer / File(s) Summary
Document mapping examples
jsonapi-java-jackson3/README.md		 The README separates document writing, bare ResourceObject conversion, and collection-document creation examples. It documents default identifier string conversion and custom IdentifierConverter usage.

Estimated code review effort: 1 (Trivial) | ~3 minutes

Possibly related PRs

🚥 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 clearly and concisely describes the documentation changes to the Jackson 3 domain mapping examples.
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 docs/clarify-jackson3-mapping-examples

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

@sonarqubecloud

sonarqubecloud Bot commented Aug 2, 2026

Copy link
Copy Markdown

Quality Gate Passed Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarQube Cloud

@kazemek

kazemek commented Aug 2, 2026

Copy link
Copy Markdown
Collaborator Author

@CodeRabbit review

@coderabbitai

coderabbitai Bot commented Aug 2, 2026 •
edited
Loading

Copy link
Copy Markdown
✅ Action performed

Review finished.

Note: CodeRabbit is an incremental review system and does not re-review already reviewed commits. This command is applicable only when automatic reviews are paused.

@kazemek

kazemek commented Aug 2, 2026

Copy link
Copy Markdown
Collaborator Author

@CodeRabbit review

@coderabbitai

coderabbitai Bot commented Aug 2, 2026 •
edited
Loading

Copy link
Copy Markdown
✅ Action performed

Review finished.

Note: CodeRabbit is an incremental review system and does not re-review already reviewed commits. This command is applicable only when automatic reviews are paused.

@kazemek
kazemek merged commit 993e037 into main Aug 2, 2026
3 checks passed
@kazemek
kazemek deleted the docs/clarify-jackson3-mapping-examples branch August 2, 2026 19:34
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@coderabbitai coderabbitai[bot] coderabbitai[bot] approved these changes

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

See More

Successfully merging this pull request may close these issues.

1 participant

@kazemek