Skip to content

feat: change patch recommendation (#846)#863

Merged
tkrop merged 5 commits into
mainfrom
patch
May 4, 2026
Merged

feat: change patch recommendation (#846)#863
tkrop merged 5 commits into
mainfrom
patch

Conversation

@tkrop
Copy link
Copy Markdown
Member

@tkrop tkrop commented Apr 28, 2026

This pull request proposes the change the PATCH guideline to account for the increased PUT complexity imposed by the additional requirements to cope with compatible updates. It suggest to now prefer the application of PATCH patterns as primary approach to simplify clients compared to the previous PUT approach.

This pull request is a counter proposal to fix #846 by accepting engineering wisdom as it is already applied.

Signed-off-by: Tronje Krop <tronje.krop@jactors.de>
@tkrop tkrop self-assigned this Apr 28, 2026
@tkrop tkrop added documentation architectural New features and architectural changes, e.g. framework changes, migrations, rollout of new services. no-zally-change labels Apr 28, 2026
Comment thread chapters/http-requests.adoc Outdated
Co-authored-by: bocytko <bocytko@gmail.com>
Copy link
Copy Markdown
Member

@tfrauenstein tfrauenstein left a comment

Choose a reason for hiding this comment

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

LGTM, thx!
(Two minor editorial change proposals.)

Comment thread chapters/http-requests.adoc Outdated
Comment thread chapters/http-requests.adoc Outdated
tkrop and others added 2 commits April 30, 2026 17:41
Co-authored-by: Thomas Frauenstein <thomas.frauenstein@zalando.de>
Co-authored-by: Thomas Frauenstein <thomas.frauenstein@zalando.de>
@tfrauenstein
Copy link
Copy Markdown
Member

👍

Copy link
Copy Markdown
Member

@SmilyOrg SmilyOrg left a comment

Choose a reason for hiding this comment

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

I approve this wholeheartedly! 👍️

Comment thread chapters/http-requests.adoc Outdated
{PATCH}, if the request does not modify the resource in a way defined by
the semantics of the standard media types above.

*Note:* In earlier versions we proposed to avoid {PATCH} and use {PUT} with complete objects to update a (sub)-resource as long as feasible, however, due
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Nitpick: this long line breaks the column limit the file tries to keep

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

You got me. I overlooked this 🥇

Signed-off-by: Tronje Krop <tronje.krop@jactors.de>
@tkrop
Copy link
Copy Markdown
Member Author

tkrop commented May 4, 2026

👍

@tkrop tkrop merged commit db9c5b8 into main May 4, 2026
6 checks passed
@tkrop tkrop deleted the patch branch May 4, 2026 12:12
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

architectural New features and architectural changes, e.g. framework changes, migrations, rollout of new services. documentation no-zally-change

Projects

None yet

Development

Successfully merging this pull request may close these issues.

PUT/POST on subrescources instead of PATCH?

4 participants