Skip to content

Commit 05ff90c

Browse files
committed
doc: explicit edit behavioral notice in CHANGELOG.md
Signed-off-by: Marc Nuri <[email protected]>
1 parent 989e351 commit 05ff90c

File tree

1 file changed

+5
-4
lines changed

1 file changed

+5
-4
lines changed

CHANGELOG.md

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -50,10 +50,11 @@
5050
* Fix #4825: removed or deprecated/moved methods that are unrelated to the rolling timeout from ImageEditReplacePatchable. Deprecated rollout methods for timeout and edit - future versions will not support
5151
* Fix #4826: removed RequestConfig upload connection and rolling timeouts. Both were no longer used with no plans to re-introduce their usage.
5252
* Fix #4861: several breaking changes related to resourceVersion handling and the replace operation:
53-
- replace is deprecated, you should use update instead. If you set the resourceVersion to null it will not be optimistically locked
54-
- json patch methods using an item for the diff generation such as edit or patch will no longer omit the resourceVersion in the patch. If you want the patch to be unlocked, then set the resourceVersion to null on the item to be patched.
55-
- createOrReplace is deprecated, you should use server side apply instead.
56-
- internal logic to mimic an apply that modify an item prior to a json patch is deprecated - you should instead build the item to be patched off of base version, such as with the edit method.
53+
- `replace` is deprecated, you should use `update` instead. If you set the resourceVersion to null it will not be optimistically locked.
54+
- `createOrReplace` is deprecated, you should use server side apply instead.
55+
- `edit` uses now optimistic locking by default. To disable locking you should change your methods to follow this pattern: `.edit(pod -> new PodBuilder(pod).editMetadata().withResourceVersion(null)//...`
56+
- JSON patch methods using an item for the diff generation such as edit or patch will no longer omit the resourceVersion in the patch. If you want the patch to be unlocked, then set the resourceVersion to null on the item to be patched.
57+
- internal logic to mimic an apply that modify an item prior to a JSON patch is deprecated - you should instead build the item to be patched off of base version, such as with the edit method.
5758

5859
### 6.4.1 (2023-01-31)
5960

0 commit comments

Comments
 (0)