Skip to content

Commit

Permalink
routing_rules: Tweak markdown help
Browse files Browse the repository at this point in the history
- Adds missing 'persistent' key
- Improves verbiage around 'escalation' type
- Fixes filter effect markdown
  • Loading branch information
nbrahms committed Apr 9, 2024
1 parent fb407d0 commit a0756de
Show file tree
Hide file tree
Showing 2 changed files with 12 additions and 11 deletions.
11 changes: 6 additions & 5 deletions docs/resources/routing_rules.md
Original file line number Diff line number Diff line change
Expand Up @@ -105,9 +105,9 @@ See [the Resource docs](https://docs.p0.dev/just-in-time-access/request-routing#
Required:

- `effect` (String) The filter effect. May be one of:
- 'keep': Access rule only applies to items matching this filter
- 'remove': Access rule only applies to items _not_ matching this filter
- 'removeAll': Access rule does not apply to any item with this filter key
- 'keep': Access rule only applies to items matching this filter
- 'remove': Access rule only applies to items _not_ matching this filter
- 'removeAll': Access rule does not apply to any item with this filter key

Optional:

Expand All @@ -125,9 +125,10 @@ Required:
- `type` (String) Determines trust requirements for access. If empty, access is disallowed. Except for 'deny', meeting any requirement is sufficient to grant access. Possible values:
- 'auto': Access is granted according to the requirements of the specified 'integration'
- 'deny': Access is always denied
- 'escalation': Access may be approved by on-call members of the specified services, who are paged when access is requested
- 'escalation': Access may be approved by on-call members of the specified services, who are paged when access is manually escalated by the requestor
- 'group': Access may be granted by any member of the defined directory group
- 'p0': Access may be granted by any user with the P0 approval role (defined in the P0 app)
- 'persistent': Access is always granted
- 'p0': Access may be granted by any user with the P0 "approver" role (defined in the P0 app)

Optional:

Expand Down
12 changes: 6 additions & 6 deletions internal/provider/resources/routing_rules.go
Original file line number Diff line number Diff line change
Expand Up @@ -146,10 +146,9 @@ See [the Resource docs](https://docs.p0.dev/just-in-time-access/request-routing#
Attributes: map[string]schema.Attribute{
"effect": schema.StringAttribute{
MarkdownDescription: `The filter effect. May be one of:
- 'keep': Access rule only applies to items matching this filter
- 'remove': Access rule only applies to items _not_ matching this filter
- 'removeAll': Access rule does not apply to any item with this filter key
`,
- 'keep': Access rule only applies to items matching this filter
- 'remove': Access rule only applies to items _not_ matching this filter
- 'removeAll': Access rule does not apply to any item with this filter key`,
Required: true,
},
"key": schema.StringAttribute{
Expand Down Expand Up @@ -224,9 +223,10 @@ See [the Resource docs](https://docs.p0.dev/just-in-time-access/request-routing#
MarkdownDescription: `Determines trust requirements for access. If empty, access is disallowed. Except for 'deny', meeting any requirement is sufficient to grant access. Possible values:
- 'auto': Access is granted according to the requirements of the specified 'integration'
- 'deny': Access is always denied
- 'escalation': Access may be approved by on-call members of the specified services, who are paged when access is requested
- 'escalation': Access may be approved by on-call members of the specified services, who are paged when access is manually escalated by the requestor
- 'group': Access may be granted by any member of the defined directory group
- 'p0': Access may be granted by any user with the P0 approval role (defined in the P0 app)`,
- 'persistent': Access is always granted
- 'p0': Access may be granted by any user with the P0 "approver" role (defined in the P0 app)`,
Required: true,
},
},
Expand Down

0 comments on commit a0756de

Please sign in to comment.