From 6b6f94b9b35aa9874df26759f18db0c0cfdbbad2 Mon Sep 17 00:00:00 2001 From: Silvan <27845747+adlerhurst@users.noreply.github.com> Date: Tue, 14 Oct 2025 09:13:52 +0200 Subject: [PATCH] docs(api_design): clarify `Set` operation (#10903) The `Set` operation replaces the object, it must now allow partial changes. # Which Problems Are Solved The definition of the `Set` operation was unclear. # How the Problems Are Solved Removed unclear description. --- API_DESIGN.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/API_DESIGN.md b/API_DESIGN.md index cdf43a71d..c13e1c64d 100644 --- a/API_DESIGN.md +++ b/API_DESIGN.md @@ -252,7 +252,7 @@ Methods on a resource MUST be named using the following convention: | Create | Create\ | Create a new resource. If the new resource conflicts with an existing resources uniqueness (id, loginname, ...) the creation MUST be prevented and an error returned. | | Update | Update\ | Update an existing resource. In most cases this SHOULD allow partial updates. If there are exception, they MUST be explicitly documented on the endpoint. The resource MUST already exists. An error is returned otherwise. | | Delete | Delete\ | Delete an existing resource. If the resource does not exist, no error SHOULD be returned. In case of an exception to this rule, the behavior MUST clearly be documented. | -| Set | Set\ | Set a resource. This will replace the existing resource with the new resource. In case where the creation and update of a resource do not need to be differentiated, a single `Set` method SHOULD be used. It SHOULD allow partial changes. | +| Set | Set\ | Set a resource. This will replace the existing resource with the new resource. In case where the creation and update of a resource do not need to be differentiated, a single `Set` method SHOULD be used. | | Get | Get\ | Retrieve a single resource by its unique identifier. If the resource does not exist, an error MUST be returned. | | List | List\ | Retrieve a list of resources. The endpoint SHOULD provide options to filter, sort and paginate. |