Update Wave docs to use 204 No Content where appropriate
#76
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
…e as the expected response.
apradoada
reviewed
Feb 25, 2025
Contributor
apradoada
left a comment
apradoada
left a comment
There was a problem hiding this comment.
This looks good! There's one sentence that gets repeated a few times that felt a little clunky so I added in a potential alternate structure just in case you want to go with that!
| and get this response: | ||
|
|
||
| `200 OK` | ||
| `204 No Content` |
ada-project-docs/wave_03.md
Outdated
|
|
||
| The response should have a mimetype of "application/json" to keep our API response type consistent. | ||
|
|
||
| If after the `PATCH` request I fetch the task by sending a `GET` request to `/tasks/1`, I get this response: |
Contributor
There was a problem hiding this comment.
Wording is just a little confusing here. Maybe something like:
Suggested change
| If after the `PATCH` request I fetch the task by sending a `GET` request to `/tasks/1`, I get this response: | |
| After I have made the 'PATCH' request, I can submit a 'GET' request to 'tasks/1, which will return the response: |
Contributor
Author
There was a problem hiding this comment.
This reads much easier, thanks for the suggestion!
ada-project-docs/wave_03.md
Outdated
|
|
||
| The response should have a mimetype of "application/json" to keep our API response type consistent. | ||
|
|
||
| If after the `PATCH` request I fetch the task by sending a `GET` request to `/tasks/1`, I get this response: |
Contributor
There was a problem hiding this comment.
Same as before,
Suggested change
| If after the `PATCH` request I fetch the task by sending a `GET` request to `/tasks/1`, I get this response: | |
| After I have made the 'PATCH' request, I can submit a 'GET' request to 'tasks/1, which will return the response: |
ada-project-docs/wave_03.md
Outdated
|
|
||
| The response should have a mimetype of "application/json" to keep our API response type consistent. | ||
|
|
||
| If after the `PATCH` request I fetch the task by sending a `GET` request to `/tasks/1`, I get this response: |
Contributor
There was a problem hiding this comment.
Same as before. It's just a really clunky sentence to write!
Suggested change
| If after the `PATCH` request I fetch the task by sending a `GET` request to `/tasks/1`, I get this response: | |
| After I have made the 'PATCH' request, I can submit a 'GET' request to 'tasks/1, which will return the response: |
ada-project-docs/wave_03.md
Outdated
|
|
||
| The response should have a mimetype of "application/json" to keep our API response type consistent. | ||
|
|
||
| If after the `PATCH` request I fetch the task by sending a `GET` request to `/tasks/1`, I get this response: |
Contributor
There was a problem hiding this comment.
No need to take the suggestion, I'm just adding it again so its easier for you to commit the suggestions if you do!
Suggested change
| If after the `PATCH` request I fetch the task by sending a `GET` request to `/tasks/1`, I get this response: | |
| After I have made the 'PATCH' request, I can submit a 'GET' request to 'tasks/1, which will return the response:``` |
Update sentence around checking results after `PATCH` in wave 4 docs
apradoada
approved these changes
Feb 25, 2025
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.
Asana Task
Update Wave docs to reflect that PUT/PATCH/DELETE endpoints should use
204 No Contentas the expected response.This PR addresses the wave documents, the tests for the affected endpoints are being updated in a separate PR that will also update the tests to use the newer DB syntax.