Document archiving and unarchiving a project - #432
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
You can archive and unarchive a project over the API. Both endpoints already existed, but they were undocumented and answered JSON requests with a redirect instead of a status code. They now return
204 No Content, and they're documented.Archive a project —
PUT /projects/1/status/archived.jsonUnarchive a project —
PUT /projects/1/status/active.json, which restores a project from the trash as well as from the archive.This closes a gap in the docs:
GET /projects.json?status=archivedhas always let you read archived projects, but there was no documented way to set that status.Two responses worth knowing about, both documented:
403 Forbiddenwhen archiving. Unarchiving is not restricted this way.507 Insufficient Storagewhen the account has reached its project limit, with the same error body already documented under "Create a project".If you're already calling these endpoints, they used to return a
302to a URL that then failed. You'll now get a204directly. The archive or unarchive itself succeeded in both cases — the difference is that there's no longer a redirect to follow.Synced from bc3
doc/api/byscript/api/sync_to_bc3_api— not a hand-edit.