Skip to content

Commit

Permalink
basic readme for rule parser nested module
Browse files Browse the repository at this point in the history
  • Loading branch information
m13t committed Apr 17, 2024
1 parent e39d290 commit ae384ed
Showing 1 changed file with 34 additions and 0 deletions.
34 changes: 34 additions & 0 deletions modules/rules_parser/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
<!-- BEGIN_TF_DOCS -->
## Requirements

No requirements.

## Providers

No providers.

## Modules

No modules.

## Resources

No resources.

## Inputs

| Name | Description | Type | Default | Required |
|------|-------------|------|---------|:--------:|
| <a name="input_rules"></a> [rules](#input\_rules) | List of rules. Each entry should be a single rule declaration | `list(string)` | n/a | yes |

## Outputs

| Name | Description |
|------|-------------|
| <a name="output_comments"></a> [comments](#output\_comments) | List of comments |
| <a name="output_disabled"></a> [disabled](#output\_disabled) | List of disabled rules |
| <a name="output_duplicate_sids"></a> [duplicate\_sids](#output\_duplicate\_sids) | List of duplicate statement identifiers for enabled rules |
| <a name="output_enabled"></a> [enabled](#output\_enabled) | List of enabled rules |
| <a name="output_generated"></a> [generated](#output\_generated) | n/a |
| <a name="output_invalid"></a> [invalid](#output\_invalid) | List of rules that failed to be parsed |
<!-- END_TF_DOCS -->

0 comments on commit ae384ed

Please sign in to comment.