routing_rules: Fix schema #3
Merged
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
Resources and requestors are required, so should be attributes, not blocks (which are always optional). Also improve documentation around setting the P0_API_TOKEN environment variable.
gergas3
approved these changes
Apr 9, 2024
| - `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 |
There was a problem hiding this comment.
Suggested change
| - '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, after the access request is escalated by the requestor |
| - '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 | ||
| - '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) |
There was a problem hiding this comment.
Suggested change
| - 'p0': Access may be granted by any user with the P0 approval role (defined in the P0 app) | |
| - 'p0': Access may be granted by any user with the P0 approver role (defined in the P0 app) |
Comment on lines
+134
to
+140
| - `directory` (String) May only be used if 'type' is 'group'. One of "azure-ad", "okta", or "workspace". | ||
| - `id` (String) May only be used if 'type' is 'group'. This is the directory's internal group identifier for matching approvers. | ||
| - `integration` (String) May only be used if 'type' is 'auto' or 'escalation'. Possible values: | ||
| - 'pagerduty': Access is granted if the requestor is on-call. | ||
| - `label` (String) May only be used if 'type' is 'group'. This is any human-readable name for the directory group specified in the 'id' attribute. | ||
| - `options` (Attributes) If present, determines additional trust requirements. (see [below for nested schema](#nestedatt--rule--approval--options)) | ||
| - `services` (List of String) May only be used if 'type' is 'escalation'. Defines which services to page on escalation. |
There was a problem hiding this comment.
I would reorder them so type=group and type=auto/escalation bullet points are together
Suggested change
| - `directory` (String) May only be used if 'type' is 'group'. One of "azure-ad", "okta", or "workspace". | |
| - `id` (String) May only be used if 'type' is 'group'. This is the directory's internal group identifier for matching approvers. | |
| - `integration` (String) May only be used if 'type' is 'auto' or 'escalation'. Possible values: | |
| - 'pagerduty': Access is granted if the requestor is on-call. | |
| - `label` (String) May only be used if 'type' is 'group'. This is any human-readable name for the directory group specified in the 'id' attribute. | |
| - `options` (Attributes) If present, determines additional trust requirements. (see [below for nested schema](#nestedatt--rule--approval--options)) | |
| - `services` (List of String) May only be used if 'type' is 'escalation'. Defines which services to page on escalation. | |
| - `directory` (String) May only be used if 'type' is 'group'. One of "azure-ad", "okta", or "workspace". | |
| - `id` (String) May only be used if 'type' is 'group'. This is the directory's internal group identifier for matching approvers. | |
| - `label` (String) May only be used if 'type' is 'group'. This is any human-readable name for the directory group specified in the 'id' attribute. | |
| - `integration` (String) May only be used if 'type' is 'auto' or 'escalation'. Possible values: | |
| - 'pagerduty': Access is granted if the requestor is on-call. | |
| - `services` (List of String) May only be used if 'type' is 'escalation'. Defines which services to page on escalation. | |
| - `options` (Attributes) If present, determines additional trust requirements. (see [below for nested schema](#nestedatt--rule--approval--options)) |
There was a problem hiding this comment.
This is just a code move; maybe we can address these markdown suggestions in a separate PR?
There was a problem hiding this comment.
This is automatically generated and will always be alphabetical.
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.
Resources and requestors are required, so should be attributes, not blocks (which are always optional).
Also improve documentation around setting the P0_API_TOKEN environment variable.