Update Provider.SetRecords documentation to clearly state it is for updates only #13
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
MasterEvarior
requested changes
Nov 13, 2024
Collaborator
MasterEvarior
left a comment
MasterEvarior
left a comment
There was a problem hiding this comment.
So this is a tricky one. As you can see from this line onwards, it should create a new record if it does not already exist. This behavior is known and desired.
Instead of updating the documentation, I'd rather fix the (potential) bug. Currently it only checks for HTTP 404. Maybe there should also be a check for HTTP 405?
Contributor
Author
|
Oh wow, I totally missed that one. I will have a look at it. Today I was focussed on integrating the client in a custom Terraform provider. Thanks for your feedback! |
Contributor
Author
|
I was not able to reproduce this issue. I will close the PR and eventually reopen if I manage to reproduce it. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
This PR aims to clarify that the SetRecords function is only
usable for updating existing records.
As the current API documentation states:
See: https://api.ns1.hosttech.eu/api/documentation/#/Records/put_api_user_v1_zones__zoneId__records__recordId_
Closes #11