[incubator-opendal] 04/04: Add changelog

[xu...@apache.org]

This is an automated email from the ASF dual-hosted git repository.

xuanwo pushed a commit to branch release-0.36.0-rc1
in repository https://gitbox.apache.org/repos/asf/incubator-opendal.git

commit e7c91e40d92de9d9900ec483bf9f496382566655
Author: Xuanwo <gi...@xuanwo.io>
AuthorDate: Tue May 30 15:36:58 2023 +0800

    Add changelog
    
    Signed-off-by: Xuanwo <gi...@xuanwo.io>
---
 CHANGELOG.md             |  1 -
 core/src/docs/upgrade.md | 52 ++++++++++++++++++++++++++++++++++++++++++++++++
 2 files changed, 52 insertions(+), 1 deletion(-)

diff --git a/CHANGELOG.md b/CHANGELOG.md
index 518f24d1..c91381e1 100644
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@@ -60,7 +60,6 @@ and this project adheres to [Semantic Versioning](https://semver.org/).
 
 ### CI
 
-- build(bindings/java): prepare for snapshot release (#2301)
 - build(bindings/java): prepare for snapshot release (#2301)
 - build(bindings/java): support multiple platform java bindings  (#2324)
 - ci(binding/nodejs): Use docker to build nodejs binding (#2328)
diff --git a/core/src/docs/upgrade.md b/core/src/docs/upgrade.md
index 9a0d9845..13878466 100644
--- a/core/src/docs/upgrade.md
+++ b/core/src/docs/upgrade.md
@@ -1,3 +1,55 @@
+# Upgarde to v0.36
+
+## Public API
+
+In v0.36, OpenDAL improving the `xxx_with` API by allow it to be called in chain:
+
+After this change, all `xxx_with` alike call will be changed from
+
+```rust
+let bs = op.read_with(
+  "path/to/file",
+  OpRead::new()
+    .with_range(0..=1024)
+    .with_if_match("<etag>")
+    .with_if_none_match("<etag>")
+    .with_override_cache_control("<cache_control>")
+    .with_override_content_disposition("<content_disposition>")
+  ).await?;
+```
+
+to
+
+```rust
+let bs = op.read_with("path/to/file")
+  .range(0..=1024)
+  .if_match("<etag>")
+  .if_none_match("<etag>")
+  .override_cache_control("<cache_control>")
+  .override_content_disposition("<content_disposition>")
+  .await?;
+```
+
+For blocking API calls, we will need a `call()` at the end:
+
+```rust
+let bs = bop.read_with("path/to/file")
+  .range(0..=1024)
+  .if_match("<etag>")
+  .if_none_match("<etag>")
+  .override_cache_control("<cache_control>")
+  .override_content_disposition("<content_disposition>")
+  .call()?;
+```
+
+Along with this change, users don't need to call `OpXxx` anymore so we moved it to `raw` API.
+
+More detailes could be found at [RFC: Chain Based Operator API][crate::docs::rfcs::rfc_2299_chain_based_operator_api].
+
+## Raw API
+
+Migrated `opendal::ops` to `opendal::raw::ops`.
+
 # Upgrade to v0.35
 
 ## Public API