Add NameSilo provider #866
Open
Conversation
This file contains 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
qdm12
reviewed
Dec 2, 2024
| ### Compulsory parameters | ||
|
|
||
| - `"domain"` is the domain to update. It can be `example.com` (root domain), `sub.example.com` (subdomain of `example.com`) or `*.example.com` for the wildcard. | ||
| - `"key"` is the NameSilo API Key obtained using domain setup instructions below. Example: `71dZaE8c2Aa926Ca2E8c1`. |
There was a problem hiding this comment.
Suggested change
| - `"key"` is the NameSilo API Key obtained using domain setup instructions below. Example: `71dZaE8c2Aa926Ca2E8c1`. | |
| - `"key"` is the NameSilo API Key obtained using the domain setup instructions below. For example: `71dZaE8c2Aa926Ca2E8c1`. |
| ## Domain setup | ||
|
|
||
| 1. Login to the [Namesilo API Manager](https://www.namesilo.com/account/api-manager) with your account credentials. | ||
|
|
There was a problem hiding this comment.
nit no need for an empty line
Suggested change
| ## Testing | ||
|
|
||
| 1. Go to the [NameSilo Domain Manager](https://www.namesilo.com/account_domains.php). | ||
|
|
There was a problem hiding this comment.
nit no need for an empty line
Suggested change
| ttl *uint32 | ||
| } | ||
|
|
||
| type APIResponse struct { |
There was a problem hiding this comment.
do not export this, rename to apiResponse
| case ttl != nil && *ttl < minTTL: | ||
| return fmt.Errorf("%w: %d must be at least %d", errors.ErrTTLTooLow, *ttl, minTTL) | ||
| case ttl != nil && *ttl > maxTTL: | ||
| return fmt.Errorf("%w: %d must be at least %d", errors.ErrTTLTooHigh, *ttl, maxTTL) |
There was a problem hiding this comment.
Suggested change
| return fmt.Errorf("%w: %d must be at least %d", errors.ErrTTLTooHigh, *ttl, maxTTL) | |
| return fmt.Errorf("%w: %d must be at most %d", errors.ErrTTLTooHigh, *ttl, maxTTL) |
Comment on lines
+259
to
+260
| return nil, fmt.Errorf("%w: %d: %s", | ||
| errors.ErrHTTPStatusNotValid, response.StatusCode, utils.ToSingleLine(string(data))) |
There was a problem hiding this comment.
do they return any structured error body i.e. json when the status code isn't ok?
Also, when the record is created, do they return status ok or status created (201)?
|
|
||
| err = p.validateResponseCode(parsedResponse.Reply.Code, parsedResponse.Reply.Detail) | ||
| if err != nil { | ||
| return nil, err |
There was a problem hiding this comment.
Suggested change
| return nil, err | |
| return nil, fmt.Errorf("validating reply code: %w", err) |
Comment on lines
+278
to
+280
| // The API inconsistently swaps between number and string typing for the code field, | ||
| // but the value should always be an integer. | ||
| parsedCode, err := code.Int64() |
| return fmt.Errorf("%w: %d: %s", err, parsedCode, detail) | ||
| } | ||
|
|
||
| // Unknown response code |
There was a problem hiding this comment.
nit unneeded comment
Suggested change
| // Unknown response code |
Comment on lines
+41
to
+42
| [](https://www.namesilo.com/account/api-manager) | ||
| [](https://www.namesilo.com/account/api-manager) |
There was a problem hiding this comment.
Thank you so much for taking the extra time to do screenshots! However, being mindful of the size of repo, would you mind compressing them in jpeg format so save a few kilobytes (since png is lossless)? Thanks!!
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.
Adds support for NameSilo. Resolves #313
I have tested locally and it seems to work for my domains. Wildcards and IPv6 are supported. The provider will create a new record if one does not already exist.
With credit to @Zeustopher for writing most of the readme in this comment.
The API documentation is here for reference: NameSilo API Reference.