This is an automated email from the ASF dual-hosted git repository.
chaokunyang pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/fory.git
The following commit(s) were added to refs/heads/main by this push:
new 917673d1d docs: add README schema IDL example (#3665)
917673d1d is described below
commit 917673d1d51c0f6b53fa82875464303ede3ec9f8
Author: Shawn Yang <[email protected]>
AuthorDate: Sat May 9 16:02:42 2026 +0800
docs: add README schema IDL example (#3665)
## Why?
## What does this PR do?
## Related issues
## AI Contribution Checklist
- [ ] Substantial AI assistance was used in this PR: `yes` / `no`
- [ ] If `yes`, I included a completed [AI Contribution
Checklist](https://github.com/apache/fory/blob/main/AI_POLICY.md#9-contributor-checklist-for-ai-assisted-prs)
in this PR description and the required `AI Usage Disclosure`.
- [ ] If `yes`, my PR description includes the required `ai_review`
summary and screenshot evidence of the final clean AI review results
from both fresh reviewers on the current PR diff or current HEAD after
the latest code changes.
## Does this PR introduce any user-facing change?
- [ ] Does this PR introduce any public API change?
- [ ] Does this PR introduce any binary protocol compatibility change?
## Benchmark
---
README.md | 21 +++++++++++++++++++++
1 file changed, 21 insertions(+)
diff --git a/README.md b/README.md
index 6964aa0f4..dac112c71 100644
--- a/README.md
+++ b/README.md
@@ -665,6 +665,27 @@ KotlinSerializers.registerSerializers(fory)
// Register, serialize, and deserialize as in the xlang example above.
```
+## Schema IDL
+
+Fory IDL is Fory's schema language for shared data models. It supports
+references, nullable fields, lists, maps, arrays, enums, messages, and unions,
+and generates native data structures for supported languages. Use it when
+multiple languages need one shared contract.
+
+```protobuf
+package tree;
+
+message TreeNode {
+ string id = 1;
+ string name = 2;
+
+ list<ref TreeNode> children = 3;
+ ref(weak=true) TreeNode parent = 4; // back-pointer
+}
+```
+
+See the [Fory IDL and compiler guide](https://fory.apache.org/docs/compiler).
+
## Row Format
Row format is for random access and partial reads. These examples encode an
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
