Skip to content

Commit

Permalink
📄 Make all boolean help consistent (#4396)
Browse files Browse the repository at this point in the history
* makes all boolean help consistent

* Update providers/snowflake/resources/snowflake.resources.json

Signed-off-by: Tim Smith <tsmith84@gmail.com>

---------

Signed-off-by: Tim Smith <tsmith84@gmail.com>
Co-authored-by: Tim Smith <tsmith84@gmail.com>
  • Loading branch information
misterpantz and tas50 authored Jul 22, 2024
1 parent a8d0800 commit f5fade5
Show file tree
Hide file tree
Showing 18 changed files with 88 additions and 88 deletions.
4 changes: 2 additions & 2 deletions providers/ansible/resources/ansible.lr
Original file line number Diff line number Diff line change
Expand Up @@ -29,9 +29,9 @@ ansible.play @defaults("name") {
strategy string
// Maximum number of hosts to fail before quitting
maxFailPercentage int
// Flag to ignore unreachable hosts
// Whether to ignore unreachable hosts
ignoreUnreachable bool
// Flag to finish fatal on any error
// Whether to finish fatal on any error
anyErrorsFatal bool
// Playbook variables
vars map[string]dict
Expand Down
6 changes: 3 additions & 3 deletions providers/arista/resources/arista.lr
Original file line number Diff line number Diff line change
Expand Up @@ -64,15 +64,15 @@ arista.eos.user @defaults("name privilege") {
private arista.eos.role @defaults("name default"){
// Name of role
name string
// Flag for default role
// Whether this is the default role
default bool
// List of rules that restricts access to specified commands
rules []dict
}

// Arista EOS SNMP information resource
arista.eos.snmpSetting {
// SNMP logging status
// Whether SNMP logging is enabled
enabled bool
// SNMP trap generation information
notifications() []dict
Expand Down Expand Up @@ -177,7 +177,7 @@ arista.eos.spt.mstInterface @defaults("name") {
inconsistentFeatures dict
// Port Number
portNumber int
// Flag if it is an edge port
// Whether the interface is an edge port
isEdgePort bool
// Details about Designated root, Designated bridge and Designated port
detail dict
Expand Down
56 changes: 28 additions & 28 deletions providers/aws/resources/aws.lr
Original file line number Diff line number Diff line change
Expand Up @@ -673,7 +673,7 @@ private aws.efs.filesystem @defaults("name id region") {
id string
// ARN of the file system
arn string
// Whether or not the file system is encrypted
// Whether the file system is encrypted
encrypted bool
// KMS key used for encryption of the file system
kmsKey() aws.kms.key
Expand Down Expand Up @@ -703,7 +703,7 @@ private aws.kms.key @defaults("id region metadata.Description") {
arn string
// Region the key lives in
region string
// Bool that specifies whether key rotation is enabled
// Whether key rotation is enabled
keyRotationEnabled() bool
// Metadata for the key
metadata() dict
Expand Down Expand Up @@ -743,7 +743,7 @@ private aws.iam.usercredentialreportentry @defaults("arn") {
// ARN for the credential report
arn() string

// Denotes if the access key is active
// Whether the access key is active
accessKey1Active() bool
// Time when key was last rotated
accessKey1LastRotated() time
Expand All @@ -754,7 +754,7 @@ private aws.iam.usercredentialreportentry @defaults("arn") {
// Service that last used the key
accessKey1LastUsedService() string

// Denotes if the access key is active
// Whether the access key is active
accessKey2Active() bool
// Time when key was last rotated
accessKey2LastRotated() time
Expand All @@ -765,17 +765,17 @@ private aws.iam.usercredentialreportentry @defaults("arn") {
// Service that last used the key
accessKey2LastUsedService() string

// Denotes if the cert is active
// Whether the cert is active
cert1Active() bool
// Time when the cert was last rotated
cert1LastRotated() time

// Denotes if the cert is active
// Whether the cert is active
cert2Active() bool
// Time when the cert was last rotated
cert2LastRotated() time

// Denotes if mfa is active in the account
// Whether MFA is active in the account
mfaActive() bool
// Whether passwords are enabled
passwordEnabled() bool
Expand Down Expand Up @@ -836,7 +836,7 @@ private aws.iam.policy @defaults("arn name") {
name() string
// Description of the policy
description() string
// Denotes if the policy can be attached
// Whether the policy can be attached
isAttachable() bool
// The number of principal entities (users, groups, and roles) that the policy is attached to
attachmentCount() int
Expand Down Expand Up @@ -865,7 +865,7 @@ private aws.iam.policyversion @defaults("arn isDefaultVersion") {
arn string
// Version ID
versionId string
// Denotes if this version is the policy default version
// Whether this version is the policy default version
isDefaultVersion bool
// JSON statements for this policy version
document() dict
Expand Down Expand Up @@ -1001,7 +1001,7 @@ private aws.es.domain @defaults("arn name") {
arn string
// Whether encryption at rest is enabled
encryptionAtRestEnabled bool
// Denoted whether node to node encryption is enabled
// Whether node-to-node encryption is enabled
nodeToNodeEncryptionEnabled bool
// Name of the Elasticsearch domain
name string
Expand Down Expand Up @@ -1097,7 +1097,7 @@ private aws.autoscaling.group @defaults("name region minSize maxSize") {
desiredCapacity int
// List of availability zones associated with the group
availabilityZones []string
// Indicates whether Capacity Rebalancing is enabled
// Whether Capacity Rebalancing is enabled
capacityRebalance bool
// The duration of the default instance warmup, in seconds
defaultInstanceWarmup int
Expand Down Expand Up @@ -1127,7 +1127,7 @@ private aws.elb.targetgroup @defaults("name port ec2Targets lambdaTargets") {
protocolVersion string
// IP address type for the load balancer target group (IPv4, IPv6)
ipAddressType string
// True if health check is enabled for the load balancer target group
// Whether health check is enabled for the load balancer target group
healthCheckEnabled bool
// Health check interval for the load balancer target group
healthCheckIntervalSeconds int
Expand Down Expand Up @@ -1312,7 +1312,7 @@ private aws.ecs.cluster @defaults("name region status runningTasksCount pendingT

// AWS ECS container instance
private aws.ecs.instance {
// True if agent is connected to ECS
// Whether the agent is connected to ECS
agentConnected bool
// ID for the container instance
id string
Expand Down Expand Up @@ -1549,9 +1549,9 @@ private aws.cloudfront.distribution @defaults("domainName status") {
cacheBehaviors []dict
// HTTP version of the distribution
httpVersion string
// Is the distribution IPV6 enabled
// Whether the distribution is IPV6 enabled
isIPV6Enabled bool
// Is the distribution enabled
// Whether the distribution is enabled
enabled bool
// The price class of the distribution
priceClass string
Expand Down Expand Up @@ -1611,7 +1611,7 @@ private aws.cloudtrail.trail @defaults("name region") {
kmsKey() aws.kms.key
// Whether the trail exists in multiple regions (false if single region)
isMultiRegionTrail bool
// Whether trail is an organization trail (logs events for management and member accounts of the organization)
// Whether the trail is an organization trail (logs events for management and member accounts of the organization)
isOrganizationTrail bool
// Whether log file validation is enabled
logFileValidationEnabled bool
Expand Down Expand Up @@ -1775,7 +1775,7 @@ private aws.backup.vault @defaults("name region") {
region string
// Date the backup vault was created
createdAt time
// Is the backup locked
// Whether the backup is locked
locked bool
// The ARN of the encryption key
encryptionKeyArn string
Expand Down Expand Up @@ -1891,7 +1891,7 @@ private aws.dynamodb.table @defaults("name region") {
tags() map[string]string
// The creation time of the table
createdTime time
// Is deletion protection enabled
// Whether deletion protection is enabled
deletionProtectionEnabled bool
// The global table version
globalTableVersion string
Expand Down Expand Up @@ -1957,9 +1957,9 @@ private aws.rds.backupsetting {
target string
// Retention period for the backup setting
retentionPeriod int
// Dedicated log volume for the backup setting
// Whether dedicated log volume is enabled for the backup setting
dedicatedLogVolume bool
// True if backups have encryption turned on
// Whether backups have encryption turned on
encrypted bool
// KMS key associated with the backup setting
kmsKey() aws.kms.key
Expand Down Expand Up @@ -2285,7 +2285,7 @@ private aws.ecr.repository @defaults("uri region") {
images() []aws.ecr.image
// Region where the image is stored
region string
// Repository option to scan on image push
// Whether the repository option to scan on image push is enabled
imageScanOnPush bool
}

Expand Down Expand Up @@ -2347,7 +2347,7 @@ private aws.apigateway.stage @defaults("arn") {
arn string
// Name for the stage
name string
// Bool that denotes if tracing is enabled for the stage
// Whether tracing is enabled for the stage
tracingEnabled bool
// Description for the stage
description string
Expand Down Expand Up @@ -2522,7 +2522,7 @@ private aws.vpc.natgateway.address {

// Amazon VPC Service Endpoint
private aws.vpc.serviceEndpoint {
// True if acceptance required
// Whether acceptance is required
acceptanceRequired bool
// List of availability zones for the service endpoint
availabilityZones []string
Expand Down Expand Up @@ -2719,7 +2719,7 @@ private aws.ec2.volume @defaults("id region volumeType size encrypted state") {
createTime time
// Region where the EC2 volume is stored
region string
// Whether Amazon EBS Multi-Attach is enabled.
// Whether Amazon EBS Multi-Attach is enabled
multiAttachEnabled bool
// The throughput that the volume supports, in MiB/s.
throughput int
Expand Down Expand Up @@ -2883,17 +2883,17 @@ private aws.ec2.networkinterface @defaults("id privateIpAddress macAddress") {
vpc() aws.vpc
// The status of the network interface. If the network interface is not attached to an instance, the status is available; if a network interface is attached to an instance the status is in-use
status string
// Indicates whether the network interface performs source/destination checking. A value of true means checking is enabled, and false means checking is disabled. The value must be false for the network interface to perform network address translation (NAT) in your VPC.
// Whether the network interface performs source/destination checking (A value of true means checking is enabled, and false means checking is disabled. The value must be false for the network interface to perform network address translation (NAT) in your VPC.)
sourceDestCheck bool
// Indicates whether the network interface is being managed by an AWS service (for example, AWS Management Console, Auto Scaling, and so on)
// Whether the network interface is being managed by an AWS service (for example, AWS Management Console, Auto Scaling, and so on)
requesterManaged bool
// Tags set on the interface
tags map[string]string
// The availability zone of the network interface
availabilityZone string
// Security groups associated with the network interface
securityGroups() []aws.ec2.securitygroup
// Indicates whether this is an IPv6 only network interface
// Whether this is an IPv6 only network interface
ipv6Native bool
// The MAC address of the network interface
macAddress string
Expand Down Expand Up @@ -2943,7 +2943,7 @@ private aws.ec2.image @defaults("ownerAlias id name") {

// Amazon EC2 instance block device
private aws.ec2.instance.device @defaults("deviceName volumeId status") {
// Boolean to denote whether volume should be deleted on instance termination
// Whether the volume should be deleted on instance termination
deleteOnTermination bool
// Status of the device
status string
Expand Down
8 changes: 4 additions & 4 deletions providers/azure/resources/azure.lr
Original file line number Diff line number Diff line change
Expand Up @@ -135,7 +135,7 @@ azure.subscription.computeService.vm @defaults("name location properties.hardwar
zones []string
// VM state
state() string
// Indicates if the VM is running
// Whether the VM is running
isRunning() bool
// VM tags
tags map[string]string
Expand Down Expand Up @@ -525,9 +525,9 @@ azure.subscription.networkService.virtualNetwork @defaults("id name location") {
subnets []azure.subscription.networkService.subnet
// Virtual Network DHCP options
dhcpOptions azure.subscription.networkService.virtualNetwork.dhcpOptions
// Indicates if DDoS protection is enabled for all the protected resources in the virtual network.
// Whether DDoS protection is enabled for all the protected resources in the virtual network
enableDdosProtection bool
// Indicates if VM protection is enabled for all the subnets in the virtual network
// Whether VM protection is enabled for all the subnets in the virtual network
enableVmProtection bool
}

Expand Down Expand Up @@ -805,7 +805,7 @@ private azure.subscription.networkService.watcher.flowlog @defaults("name locati
etag string
// Network watcher flow log provisioning state
provisioningState string
// whether the network watcher flow log is enabled
// Whether the network watcher flow log is enabled
enabled bool
// Network watcher flow log storage account identifier
storageAccountId string
Expand Down
24 changes: 12 additions & 12 deletions providers/gcp/resources/gcp.lr
Original file line number Diff line number Diff line change
Expand Up @@ -524,15 +524,15 @@ private gcp.project.computeService.attachedDisk {
projectId string
// Architecture of the attached disk
architecture string
// Indicates if disk will be auto-deleted
// Whether the disk will be auto-deleted
autoDelete bool
// Indicates that this is a boot disk
// Whether this is a boot disk
boot bool
// Unique device name
deviceName string
// Size of the disk in GB
diskSizeGb int
// Indicates whether to force attach the regional disk
// Whether to force attach the regional disk
forceAttach bool
// Features to enable on the guest operating
guestOsFeatures []string
Expand Down Expand Up @@ -560,7 +560,7 @@ private gcp.project.computeService.snapshot @defaults("name") {
description string
// Architecture of the snapshot
architecture string
// Indicates if snapshot was automatically created
// Whether the snapshot was automatically created
autoCreated bool
// Snapshot chain
chainName string
Expand Down Expand Up @@ -660,7 +660,7 @@ private gcp.project.computeService.network @defaults("name") {
description string
// If not set, indicates a legacy network
autoCreateSubnetworks bool
// Indicates if ULA internal IPv6 is enabled on this network
// Whether ULA internal IPv6 is enabled on this network
enableUlaInternalIpv6 bool
// Gateway address for default routing
gatewayIPv4 string
Expand Down Expand Up @@ -1076,7 +1076,7 @@ private gcp.project.sqlService.instance.settings {
settingsVersion int
// SQL-server-specific audit configuration
sqlServerAuditConfig dict
// Configuration to increase storage size automatically
// Whether to increase storage size automatically
storageAutoResize bool
// Maximum size to which storage capacity can be automatically increased
storageAutoResizeLimit int
Expand Down Expand Up @@ -1136,7 +1136,7 @@ private gcp.project.sqlService.instance.settings.ipConfiguration {
requireSsl bool
// Specifies how SSL/TLS is enforced in database connections.
sslMode string
// Controls connectivity to private IP instances from Google services, such as BigQuery.
// Whether the service uses an internal direct path instead of the private IP address inside of the Virtual Private Cloud (Controls connectivity to private IP instances from Google services, such as BigQuery)
enablePrivatePathForGoogleCloudServices bool
}

Expand Down Expand Up @@ -1246,9 +1246,9 @@ private gcp.project.bigqueryService.table @defaults("id") {
description string
// User-provided labels
labels map[string]string
// Indicates if Legacy SQL is used for the view query
// Whether the view query uses Legacy SQL
useLegacySQL bool
// Indicates if queries that reference this table must specify a partition filter
// Whether queries that reference this table must specify a partition filter
requirePartitionFilter bool
// Creation timestamp
created time
Expand Down Expand Up @@ -1436,7 +1436,7 @@ private gcp.project.gkeService.cluster @defaults("name description zone status c
nodePools []gcp.project.gkeService.cluster.nodepool
// The list of Google Compute Engine zones in which the cluster's nodes should be located
locations []string
// Enable Kubernetes alpha features
// Whether Kubernetes alpha features are enabled
enableKubernetesAlpha bool
// Whether Autopilot is enabled for the cluster
autopilotEnabled bool
Expand Down Expand Up @@ -1682,7 +1682,7 @@ private gcp.project.gkeService.cluster.nodepool.config @defaults("machineType di
advancedMachineFeatures gcp.project.gkeService.cluster.nodepool.config.advancedMachineFeatures
// gVNIC configuration
gvnicConfig gcp.project.gkeService.cluster.nodepool.config.gvnicConfig
// Spot flag for enabling Spot VM, which is a rebrand of the existing preemptible flag
// Whether Spot VM is enabled (a rebrand of the existing preemptible flag)
spot bool
// Confidential nodes configuration
confidentialNodes gcp.project.gkeService.cluster.nodepool.config.confidentialNodes
Expand Down Expand Up @@ -1937,7 +1937,7 @@ private gcp.project.kmsService.keyring.cryptokey @defaults("name purpose") {
versionTemplate dict
// User-defined labels
labels map[string]string
// Whether this key may contain imported versions only
// Whether this key can contain imported versions only
importOnly bool
// Period of time that versions of this key spend in DESTROY_SCHEDULED state before being destroyed
destroyScheduledDuration time
Expand Down
2 changes: 1 addition & 1 deletion providers/github/resources/github.lr
Original file line number Diff line number Diff line change
Expand Up @@ -456,7 +456,7 @@ private github.branchprotection @defaults("id") {
requiredPullRequestReviews dict
// Require conversation resolution before merging
requiredConversationResolution dict
// Require signed commits
// Whether signed commits are required
requiredSignatures bool
// Require linear history
requireLinearHistory dict
Expand Down
Loading

0 comments on commit f5fade5

Please sign in to comment.