github/terraform-provider-unifi
2
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Update docs for api_url

Browse Source
This commit is contained in:
Paul Tyng
2020-09-20 14:09:42 -04:00
parent e22dfaeda7
commit afc5e64da8
2 changed files with 3 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
docs/index.md
View File

@@ -27,7 +27,7 @@ provider "unifi" {
### Optional
- **allow_insecure** (Boolean, Optional) Skip verification of TLS certificates of API requests. You may need to set this to `true` if you are using your local API without setting up a signed certificate. Can be specified with the `UNIFI_INSECURE` environment variable.
- **api_url** (String, Optional) URL of the controller API. Can be specified with the `UNIFI_API` environment variable.
- **api_url** (String, Optional) URL of the controller API. Can be specified with the `UNIFI_API` environment variable. This typically has the `/api` path appended to it, ie. `https://192.168.1.100:8443/api`.
- **password** (String, Optional) Password for the user accessing the API. Can be specified with the `UNIFI_PASSWORD` environment variable.
- **site** (String, Optional) The site in the Unifi controller this provider will manage. Can be specified with the `UNIFI_SITE` environment variable. Default: `default`
- **username** (String, Optional) Local user name for the Unifi controller API. Can be specified with the `UNIFI_USERNAME` environment variable.

3
internal/provider/provider.go
View File

@@ -39,7 +39,8 @@ func New() *schema.Provider {
DefaultFunc: schema.EnvDefaultFunc("UNIFI_PASSWORD", ""),
},
"api_url": {
Description: "URL of the controller API. Can be specified with the `UNIFI_API` environment variable.",
Description: "URL of the controller API. Can be specified with the `UNIFI_API` environment variable. " +
"This typically has the `/api` path appended to it, ie. `https://192.168.1.100:8443/api`.",
Type: schema.TypeString,
Required: true,
DefaultFunc: schema.EnvDefaultFunc("UNIFI_API", ""),