Skip to content

Commit

Permalink
Updating docs
Browse files Browse the repository at this point in the history
  • Loading branch information
willvedd committed Dec 13, 2023
1 parent d50bfd3 commit dca0907
Show file tree
Hide file tree
Showing 3 changed files with 8 additions and 4 deletions.
6 changes: 4 additions & 2 deletions docs/resources/action.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,8 @@ description: |-

Actions are secure, tenant-specific, versioned functions written in Node.js that execute at certain points during the Auth0 runtime. Actions are used to customize and extend Auth0's capabilities with custom logic.

~> Secrets and dependencies must be managed with Terraform, they cannot be managed out-of-band.

## Example Usage

```terraform
Expand Down Expand Up @@ -65,10 +67,10 @@ resource "auth0_action" "my_action" {

### Optional

- `dependencies` (Block Set) List of third party npm modules, and their versions, that this action depends on. (see [below for nested schema](#nestedblock--dependencies))
- `dependencies` (Block Set) List of third party npm modules, and their versions, that this action depends on. If your action contains dependencies, they must be managed through Terraform; dependencies cannot be managed out-of-band. (see [below for nested schema](#nestedblock--dependencies))
- `deploy` (Boolean) Deploying an action will create a new immutable version of the action. If the action is currently bound to a trigger, then the system will begin executing the newly deployed version of the action immediately.
- `runtime` (String) The Node runtime. Defaults to `node18`. Possible values are: `node16` (not recommended), or `node18` (recommended).
- `secrets` (Block List) List of secrets that are included in an action or a version of an action. Partial management of secrets is not supported. (see [below for nested schema](#nestedblock--secrets))
- `secrets` (Block List) List of secrets that are included in an action or a version of an action. If your action contains secrets, they **must** be managed through Terraform; Secrets cannot be managed out-of-band. (see [below for nested schema](#nestedblock--secrets))

### Read-Only

Expand Down
4 changes: 2 additions & 2 deletions internal/auth0/action/resource.go
Original file line number Diff line number Diff line change
Expand Up @@ -65,7 +65,7 @@ func NewResource() *schema.Resource {
"dependencies": {
Type: schema.TypeSet,
Optional: true,
Description: "List of third party npm modules, and their versions, that this action depends on.",
Description: "List of third party npm modules, and their versions, that this action depends on. If your action contains dependencies, they must be managed through Terraform; dependencies cannot be managed out-of-band.",
Elem: &schema.Resource{
Schema: map[string]*schema.Schema{
"name": {
Expand Down Expand Up @@ -95,7 +95,7 @@ func NewResource() *schema.Resource {
"secrets": {
Type: schema.TypeList,
Optional: true,
Description: "List of secrets that are included in an action or a version of an action. Partial management of secrets is not supported.",
Description: "List of secrets that are included in an action or a version of an action. If your action contains secrets, they **must** be managed through Terraform; Secrets cannot be managed out-of-band.",
Elem: &schema.Resource{
Schema: map[string]*schema.Schema{
"name": {
Expand Down
2 changes: 2 additions & 0 deletions templates/resources/action.md.tmpl
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,8 @@ description: |-

{{ .Description | trimspace }}

~> Secrets and dependencies must be managed with Terraform, they cannot be managed out-of-band.

{{ if .HasExample -}}

## Example Usage
Expand Down

0 comments on commit dca0907

Please sign in to comment.