Skip to content

Document Location headers for created REST resources - #369

Open
pratyushsinghal7 wants to merge 2 commits into
DSpace:mainfrom
pratyushsinghal7:issue-8881-contract
Open

Document Location headers for created REST resources#369
pratyushsinghal7 wants to merge 2 commits into
DSpace:mainfrom
pratyushsinghal7:issue-8881-contract

Conversation

@pratyushsinghal7

Copy link
Copy Markdown

References

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

Specify the shared JSON creation response header and the canonical EPerson URI returned after successful account creation.
Comment thread epersons.md
@lgeggleston lgeggleston added bug 1 APPROVAL pull request only requires a single approval to merge. authentication: EPerson Related to how the EPerson object works during authentication labels Jul 24, 2026
@lgeggleston lgeggleston moved this to 👀 Under Review in DSpace 11.0 Release Jul 24, 2026
@pratyushsinghal7

Copy link
Copy Markdown
Author

@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

Copy link
Copy Markdown
Contributor

@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).

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

1 APPROVAL pull request only requires a single approval to merge. authentication: EPerson Related to how the EPerson object works during authentication bug

Projects

Status: 👀 Under Review

Development

Successfully merging this pull request may close these issues.

3 participants