Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Move lastAction out of status doc #16

Open
richard-jones opened this issue Jan 29, 2020 · 1 comment
Open

Move lastAction out of status doc #16

richard-jones opened this issue Jan 29, 2020 · 1 comment
Assignees
Labels

Comments

@richard-jones
Copy link
Contributor

lastAction is uncomfortable in the Status Doc, and would be better if it wasn't there. Instead, the proposal is: for any POST to an operation that is not to the Object-URL, we SHOULD NOT return the Status Doc (it's not RESTful to do so), instead we should return a "Last Action Doc" (which doesn't yet exist in the spec) + a Location header when the deposit operation warrants it.

The Last Action doc should contain all the data that's currently in the lastAction section of the Status Doc, and it should also be possible to include the locations of any created resources, where there are multiple resources involved. For example, deposit of multiple files By-Reference cannot return a single Location, so it should return a Last Action Doc, which lists all the files that were deposited. Exact form of this extension TBD.

@richard-jones
Copy link
Contributor Author

richard-jones commented Jul 15, 2020

After consideration, the way to move forward here is simply to remove lastAction from the Status Doc and specification as a whole. It isn't particularly useful in its current form, as noted, as the Status Doc is not returned after every request. Requiring each request to start presenting a "Last Action" document places extra burden on the client, for limited additional value. The client knows what it did, and if it wants to see the state of the object, then it can GET on the Object-URL.

Actions therefore are:

  • Remove lastAction from the Status Doc

In the process of making this decision, a Last Action document type was drafted, and this will be left in the code repository for future reference but not promoted to the specification itself.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

2 participants