marcel/familienarchiv
1
0
Fork 0
Code Issues 119 Pull Requests 2 Actions Packages Projects Releases Wiki Activity

docs(api): document reorder full-list contract in OpenAPI

Browse Source 
Add @Operation annotation to reorderItems() clarifying that itemIds must
contain ALL item IDs for the journey in the desired order — a partial list
returns 400 Bad Request. This surfaces the contract in the generated
OpenAPI spec and Swagger UI.

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
This commit is contained in:
Marcel
2026-06-08 20:52:02 +02:00
parent 73004ce49f
commit 9db3b41fdb
1 changed files with 4 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
backend/src/main/java/org/raddatz/familienarchiv/geschichte/GeschichteController.java
View File

@@ -102,6 +102,10 @@ public class GeschichteController {
@PutMapping("/{id}/items/reorder") @PutMapping("/{id}/items/reorder")
@RequirePermission(Permission.BLOG_WRITE) @RequirePermission(Permission.BLOG_WRITE)
@Operation(
summary = "Reorder journey items",
description = "itemIds must contain ALL item IDs for the given journey in the desired new order. Sending a partial list returns 400 Bad Request."
)
public List<JourneyItemView> reorderItems( public List<JourneyItemView> reorderItems(
@PathVariable UUID id, @PathVariable UUID id,
@RequestBody JourneyReorderDTO dto) { @RequestBody JourneyReorderDTO dto) {