Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

docs: enhance provider setup documentation #355

Merged
merged 2 commits into from
Aug 1, 2023
Merged

docs: enhance provider setup documentation #355

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
ed4d214
docu: enhance provider setup documentation
lechnerc77 Aug 1, 2023
14d8e1b
docu: regenerate docu
lechnerc77 Aug 1, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions docs/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,8 +37,8 @@ provider "btp" {

- `cli_server_url` (String) The URL of the BTP CLI server (e.g. `https://cpcli.cf.eu10.hana.ondemand.com`).
- `idp` (String) The identity provider to be used for authentication (default: `sap.default`).
- `password` (String, Sensitive) Your password. Note that two-factor authentication is not supported.
- `username` (String) Your user name, usually an e-mail address.
- `password` (String, Sensitive) Your password. Note that two-factor authentication is not supported. This can also be sourced from the `BTP_PASSWORD` environment variable.
- `username` (String) Your user name, usually an e-mail address. This can also be sourced from the `BTP_USERNAME` environment variable.

## Get Started

Expand Down
4 changes: 2 additions & 2 deletions internal/provider/provider.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -45,11 +45,11 @@ func (p *btpcliProvider) Schema(_ context.Context, _ provider.SchemaRequest, res
Required: true, // TODO validate UUID
},
"username": schema.StringAttribute{
MarkdownDescription: "Your user name, usually an e-mail address.",
MarkdownDescription: "Your user name, usually an e-mail address. This can also be sourced from the `BTP_USERNAME` environment variable.",
Optional: true,
},
"password": schema.StringAttribute{
MarkdownDescription: "Your password. Note that two-factor authentication is not supported.",
MarkdownDescription: "Your password. Note that two-factor authentication is not supported. This can also be sourced from the `BTP_PASSWORD` environment variable.",
Optional: true,
Sensitive: true,
},
Expand Down
Loading