Treat 201 Created response codes as successful requests#99
Merged
nywilken merged 1 commit intohashicorp:mainfrom Jan 9, 2024
Merged
Treat 201 Created response codes as successful requests#99nywilken merged 1 commit intohashicorp:mainfrom
201 Created response codes as successful requests#99nywilken merged 1 commit intohashicorp:mainfrom
Conversation
The Vagrant Cloud API responds to the creation of resources with `200
OK` and the create version and create provider steps only check for this
status code. However according to RESTful conventions the expected
response for resource creation would be `201 Created`. From MDN[1]:
The HTTP 201 Created success status response code indicates that the
request has succeeded and has led to the creation of a resource
and restfulapi.net[2]:
HTTP Status 201 indicates that as a result of HTTP POST request, one
or more new resources have been successfully created on the server.
To ensure that the post-processor works with alternative implementations
that provide Vagrant Cloud like functionality, but adhere to RESTful
conventions, it would be useful if the response code checks allowed a
`200` status code.
[1] https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/201
[2] https://restfulapi.net/http-status-201-created/
nywilken
approved these changes
Jan 9, 2024
Contributor
nywilken
left a comment
There was a problem hiding this comment.
This looks good to me. Thanks for the enhancement.
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.
The Vagrant Cloud API responds to the creation of resources with
200 OKand the create version and create provider steps only check for this status code. However according to RESTful conventions the expected response for resource creation would be201 Created. From MDN[1]:and restfulapi.net[2]:
To ensure that the post-processor works with alternative implementations that provide Vagrant Cloud like functionality, but adhere to RESTful conventions, it would be useful if the response code checks allowed a
201status code.[1] https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/201
[2] https://restfulapi.net/http-status-201-created/