docs(api): Use correct HTTP method for specific issue #13854
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
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎
2 Skipped Deployments
|
markstory
reviewed
May 28, 2025
| @@ -124,19 +124,19 @@ Resources can get complicated when you need to expose batch operations vs single | |||
| Let's say for example we have an endpoint that mutates an issue: | |||
|
|
|||
| ``` | |||
| POST /api/0/organizations/{org}/issues/{issue}/ | |||
| PUT /api/0/organizations/{org}/issues/{issue}/ | |||
There was a problem hiding this comment.
The paragraph above still says POST. I think those should be aligned.
There was a problem hiding this comment.
woops! updated it as well
coolguyzone
approved these changes
May 29, 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.
DESCRIBE YOUR PR
While going through the API docs page, I noticed that the example around mutating issues uses the POST method, but earlier on this docs page, it explicitly states that any endpoints whose purpose is to just update should be a PUT. Moreover, the endpoints in this example are real and there is no POST for them.
IS YOUR CHANGE URGENT?
No