Document Location headers for created REST resources

[pratyushsinghal7]

References

• Related to create eperson via REST API endpoint /api/eperson/epersons: add Location header with eperson UUID in HTTP response DSpace#8881
• Companion to Add Location header to created REST resources DSpace#12848

Description

Document that successful JSON collection-resource creation returns 201 Created with an absolute Location header for the created resource.

The EPerson creation contract now includes the concrete canonical URI shape returned by POST /api/eperson/epersons.

Validation

• git diff --check
• Verified the documented EPerson URI matches the backend integration assertion in Add Location header to created REST resources DSpace#12848.

[pratyushsinghal7]

@saschaszott the review feedback has been addressed in 3e89c41 — the repository-wide 201/Location contract is now in README.md, and all three EPerson POST variants in epersons.md document the returned Location URI. The companion code PR DSpace/DSpace#12848 already has two approvals (yours and @MMilosz's) and is only waiting on this contract PR, so a re-review here would be much appreciated. Thanks!

[saschaszott]

@pratyushsinghal7 , I am not sure whether my concern has been addressed. Your change to the RestResourceController base class affects not only the creation of new EPersons via POST, but ultimately all DSOs created through postJsonInternal. My point was therefore whether this change should also be documented elsewhere in the RestContract (specifically, that the Location header contains the URI of the created resource).

[tdonohue]

👍 Thanks @pratyushsinghal7 ! This looks "good enough" to me, especially since the new Location header is now mentioned in the general README.md.

I do think we could follow this PR up with additional cleanup work to document every 201 that now returns a Location header, but this is good enough for now.

[dspace-bot]

Backport failed for dspace-8_x, because it was unable to cherry-pick the commit(s).

Please cherry-pick the changes locally and resolve any conflicts.

git fetch origin dspace-8_x
git worktree add -d .worktree/backport-369-to-dspace-8_x origin/dspace-8_x
cd .worktree/backport-369-to-dspace-8_x
git switch --create backport-369-to-dspace-8_x
git cherry-pick -x 07e9e1e0adbdb2d5b2fac12014ebc6e50c9a0d0c 3e89c412342c15e2c2830a055a85046352e3afc8

[dspace-bot]

Successfully created backport PR for dspace-9_x:

• [Port dspace-9_x] Document Location headers for created REST resources #393

[dspace-bot]

Successfully created backport PR for dspace-10_x:

• [Port dspace-10_x] Document Location headers for created REST resources #394