From 282f8e3b821698903d3f4a054ebdff4d366725a7 Mon Sep 17 00:00:00 2001 From: The Magician Date: Fri, 24 Apr 2020 13:45:23 -0400 Subject: [PATCH] Add enum values generation to documentation (#3404) (#207) * Add enum values generation to documentation, remove previous handwritten lists unless they add value * Add possible enum values to inspec doc generation * Add default, possible values to the schema description * Format fixes * Try spacing to see how md looks * PR feedback * Order of operations * Bigger spacefor markdown Signed-off-by: Modular Magician --- plugins/modules/gcp_compute_address.py | 16 +++++------- plugins/modules/gcp_compute_address_info.py | 8 +++--- plugins/modules/gcp_compute_autoscaler.py | 4 +-- .../modules/gcp_compute_autoscaler_info.py | 2 +- .../modules/gcp_compute_backend_service.py | 16 +++++------- .../gcp_compute_backend_service_info.py | 8 +++--- .../modules/gcp_compute_forwarding_rule.py | 16 +++++------- .../gcp_compute_forwarding_rule_info.py | 8 +++--- plugins/modules/gcp_compute_global_address.py | 10 +++----- .../gcp_compute_global_address_info.py | 5 ++-- .../gcp_compute_global_forwarding_rule.py | 12 +++------ ...gcp_compute_global_forwarding_rule_info.py | 6 ++--- plugins/modules/gcp_compute_health_check.py | 25 ++++++++----------- .../modules/gcp_compute_health_check_info.py | 10 ++++---- .../gcp_compute_network_endpoint_group.py | 6 ++--- ...gcp_compute_network_endpoint_group_info.py | 3 +-- .../modules/gcp_compute_region_autoscaler.py | 4 +-- .../gcp_compute_region_autoscaler_info.py | 2 +- .../gcp_compute_region_backend_service.py | 19 ++++++-------- ...gcp_compute_region_backend_service_info.py | 10 +++----- .../gcp_compute_region_health_check.py | 25 ++++++++----------- .../gcp_compute_region_health_check_info.py | 10 ++++---- plugins/modules/gcp_compute_reservation.py | 6 ++--- .../modules/gcp_compute_reservation_info.py | 3 +-- .../modules/gcp_compute_resource_policy.py | 2 -- .../gcp_compute_resource_policy_info.py | 1 - plugins/modules/gcp_compute_router.py | 2 -- plugins/modules/gcp_compute_router_info.py | 1 - plugins/modules/gcp_compute_ssl_policy.py | 16 +++++------- .../modules/gcp_compute_ssl_policy_info.py | 8 +++--- .../modules/gcp_compute_target_https_proxy.py | 6 ++--- .../gcp_compute_target_https_proxy_info.py | 3 +-- .../modules/gcp_compute_target_ssl_proxy.py | 6 ++--- .../gcp_compute_target_ssl_proxy_info.py | 3 +-- .../modules/gcp_compute_target_tcp_proxy.py | 6 ++--- .../gcp_compute_target_tcp_proxy_info.py | 3 +-- plugins/modules/gcp_dns_managed_zone.py | 2 -- plugins/modules/gcp_dns_managed_zone_info.py | 1 - plugins/modules/gcp_redis_instance.py | 6 ++--- plugins/modules/gcp_redis_instance_info.py | 3 +-- 40 files changed, 114 insertions(+), 189 deletions(-) diff --git a/plugins/modules/gcp_compute_address.py b/plugins/modules/gcp_compute_address.py index 09ec477..ef2c506 100644 --- a/plugins/modules/gcp_compute_address.py +++ b/plugins/modules/gcp_compute_address.py @@ -66,8 +66,7 @@ options: type: str address_type: description: - - The type of address to reserve, either INTERNAL or EXTERNAL. - - If unspecified, defaults to EXTERNAL. + - The type of address to reserve. - 'Some valid choices include: "INTERNAL", "EXTERNAL"' required: false default: EXTERNAL @@ -99,9 +98,8 @@ options: version_added: '2.10' network_tier: description: - - 'The networking tier used for configuring this address. This field can take - the following values: PREMIUM or STANDARD. If this field is not specified, it - is assumed to be PREMIUM.' + - The networking tier used for configuring this address. If this field is not + specified, it is assumed to be PREMIUM. - 'Some valid choices include: "PREMIUM", "STANDARD"' required: false type: str @@ -200,8 +198,7 @@ address: type: str addressType: description: - - The type of address to reserve, either INTERNAL or EXTERNAL. - - If unspecified, defaults to EXTERNAL. + - The type of address to reserve. returned: success type: str creationTimestamp: @@ -238,9 +235,8 @@ purpose: type: str networkTier: description: - - 'The networking tier used for configuring this address. This field can take the - following values: PREMIUM or STANDARD. If this field is not specified, it is assumed - to be PREMIUM.' + - The networking tier used for configuring this address. If this field is not specified, + it is assumed to be PREMIUM. returned: success type: str subnetwork: diff --git a/plugins/modules/gcp_compute_address_info.py b/plugins/modules/gcp_compute_address_info.py index bc9bb04..17919ff 100644 --- a/plugins/modules/gcp_compute_address_info.py +++ b/plugins/modules/gcp_compute_address_info.py @@ -128,8 +128,7 @@ resources: type: str addressType: description: - - The type of address to reserve, either INTERNAL or EXTERNAL. - - If unspecified, defaults to EXTERNAL. + - The type of address to reserve. returned: success type: str creationTimestamp: @@ -166,9 +165,8 @@ resources: type: str networkTier: description: - - 'The networking tier used for configuring this address. This field can take - the following values: PREMIUM or STANDARD. If this field is not specified, - it is assumed to be PREMIUM.' + - The networking tier used for configuring this address. If this field is not + specified, it is assumed to be PREMIUM. returned: success type: str subnetwork: diff --git a/plugins/modules/gcp_compute_autoscaler.py b/plugins/modules/gcp_compute_autoscaler.py index f427c83..9390041 100644 --- a/plugins/modules/gcp_compute_autoscaler.py +++ b/plugins/modules/gcp_compute_autoscaler.py @@ -162,7 +162,7 @@ options: utilization_target_type: description: - Defines how target utilization value is expressed for a Stackdriver - Monitoring metric. Either GAUGE, DELTA_PER_SECOND, or DELTA_PER_MINUTE. + Monitoring metric. - 'Some valid choices include: "GAUGE", "DELTA_PER_SECOND", "DELTA_PER_MINUTE"' required: false type: str @@ -427,7 +427,7 @@ autoscalingPolicy: utilizationTargetType: description: - Defines how target utilization value is expressed for a Stackdriver Monitoring - metric. Either GAUGE, DELTA_PER_SECOND, or DELTA_PER_MINUTE. + metric. returned: success type: str loadBalancingUtilization: diff --git a/plugins/modules/gcp_compute_autoscaler_info.py b/plugins/modules/gcp_compute_autoscaler_info.py index 2f27403..e44cf5d 100644 --- a/plugins/modules/gcp_compute_autoscaler_info.py +++ b/plugins/modules/gcp_compute_autoscaler_info.py @@ -225,7 +225,7 @@ resources: utilizationTargetType: description: - Defines how target utilization value is expressed for a Stackdriver - Monitoring metric. Either GAUGE, DELTA_PER_SECOND, or DELTA_PER_MINUTE. + Monitoring metric. returned: success type: str loadBalancingUtilization: diff --git a/plugins/modules/gcp_compute_backend_service.py b/plugins/modules/gcp_compute_backend_service.py index f6c2deb..46bfe89 100644 --- a/plugins/modules/gcp_compute_backend_service.py +++ b/plugins/modules/gcp_compute_backend_service.py @@ -287,8 +287,7 @@ options: description: - Indicates whether the backend service will be used with internal or external load balancing. A backend service created for one type of load balancing cannot - be used with the other. Must be `EXTERNAL` or `INTERNAL_SELF_MANAGED` for a - global backend service. Defaults to `EXTERNAL`. + be used with the other. - 'Some valid choices include: "EXTERNAL", "INTERNAL_SELF_MANAGED"' required: false default: EXTERNAL @@ -313,9 +312,8 @@ options: protocol: description: - The protocol this BackendService uses to communicate with backends. - - 'Possible values are HTTP, HTTPS, HTTP2, TCP, and SSL. The default is HTTP. - **NOTE**: HTTP2 is only valid for beta HTTP/2 load balancer types and may result - in errors if used with the GA API.' + - 'The default is HTTP. **NOTE**: HTTP2 is only valid for beta HTTP/2 load balancer + types and may result in errors if used with the GA API.' - 'Some valid choices include: "HTTP", "HTTPS", "HTTP2", "TCP", "SSL"' required: false type: str @@ -673,8 +671,7 @@ loadBalancingScheme: description: - Indicates whether the backend service will be used with internal or external load balancing. A backend service created for one type of load balancing cannot be - used with the other. Must be `EXTERNAL` or `INTERNAL_SELF_MANAGED` for a global - backend service. Defaults to `EXTERNAL`. + used with the other. returned: success type: str name: @@ -696,9 +693,8 @@ portName: protocol: description: - The protocol this BackendService uses to communicate with backends. - - 'Possible values are HTTP, HTTPS, HTTP2, TCP, and SSL. The default is HTTP. **NOTE**: - HTTP2 is only valid for beta HTTP/2 load balancer types and may result in errors - if used with the GA API.' + - 'The default is HTTP. **NOTE**: HTTP2 is only valid for beta HTTP/2 load balancer + types and may result in errors if used with the GA API.' returned: success type: str securityPolicy: diff --git a/plugins/modules/gcp_compute_backend_service_info.py b/plugins/modules/gcp_compute_backend_service_info.py index 3827194..e01475a 100644 --- a/plugins/modules/gcp_compute_backend_service_info.py +++ b/plugins/modules/gcp_compute_backend_service_info.py @@ -356,8 +356,7 @@ resources: description: - Indicates whether the backend service will be used with internal or external load balancing. A backend service created for one type of load balancing cannot - be used with the other. Must be `EXTERNAL` or `INTERNAL_SELF_MANAGED` for - a global backend service. Defaults to `EXTERNAL`. + be used with the other. returned: success type: str name: @@ -379,9 +378,8 @@ resources: protocol: description: - The protocol this BackendService uses to communicate with backends. - - 'Possible values are HTTP, HTTPS, HTTP2, TCP, and SSL. The default is HTTP. - **NOTE**: HTTP2 is only valid for beta HTTP/2 load balancer types and may - result in errors if used with the GA API.' + - 'The default is HTTP. **NOTE**: HTTP2 is only valid for beta HTTP/2 load balancer + types and may result in errors if used with the GA API.' returned: success type: str securityPolicy: diff --git a/plugins/modules/gcp_compute_forwarding_rule.py b/plugins/modules/gcp_compute_forwarding_rule.py index 215e21c..6ea99ba 100644 --- a/plugins/modules/gcp_compute_forwarding_rule.py +++ b/plugins/modules/gcp_compute_forwarding_rule.py @@ -81,8 +81,7 @@ options: type: str ip_protocol: description: - - The IP protocol to which this rule applies. Valid options are TCP, UDP, ESP, - AH, SCTP or ICMP. + - The IP protocol to which this rule applies. - When the load balancing scheme is INTERNAL, only TCP and UDP are valid. - 'Some valid choices include: "TCP", "UDP", "ESP", "AH", "SCTP", "ICMP"' required: false @@ -197,9 +196,8 @@ options: version_added: '2.8' network_tier: description: - - 'The networking tier used for configuring this address. This field can take - the following values: PREMIUM or STANDARD. If this field is not specified, it - is assumed to be PREMIUM.' + - The networking tier used for configuring this address. If this field is not + specified, it is assumed to be PREMIUM. - 'Some valid choices include: "PREMIUM", "STANDARD"' required: false type: str @@ -352,8 +350,7 @@ IPAddress: type: str IPProtocol: description: - - The IP protocol to which this rule applies. Valid options are TCP, UDP, ESP, AH, - SCTP or ICMP. + - The IP protocol to which this rule applies. - When the load balancing scheme is INTERNAL, only TCP and UDP are valid. returned: success type: str @@ -446,9 +443,8 @@ allPorts: type: bool networkTier: description: - - 'The networking tier used for configuring this address. This field can take the - following values: PREMIUM or STANDARD. If this field is not specified, it is assumed - to be PREMIUM.' + - The networking tier used for configuring this address. If this field is not specified, + it is assumed to be PREMIUM. returned: success type: str serviceLabel: diff --git a/plugins/modules/gcp_compute_forwarding_rule_info.py b/plugins/modules/gcp_compute_forwarding_rule_info.py index efa9a54..483ebfc 100644 --- a/plugins/modules/gcp_compute_forwarding_rule_info.py +++ b/plugins/modules/gcp_compute_forwarding_rule_info.py @@ -160,8 +160,7 @@ resources: type: str IPProtocol: description: - - The IP protocol to which this rule applies. Valid options are TCP, UDP, ESP, - AH, SCTP or ICMP. + - The IP protocol to which this rule applies. - When the load balancing scheme is INTERNAL, only TCP and UDP are valid. returned: success type: str @@ -256,9 +255,8 @@ resources: type: bool networkTier: description: - - 'The networking tier used for configuring this address. This field can take - the following values: PREMIUM or STANDARD. If this field is not specified, - it is assumed to be PREMIUM.' + - The networking tier used for configuring this address. If this field is not + specified, it is assumed to be PREMIUM. returned: success type: str serviceLabel: diff --git a/plugins/modules/gcp_compute_global_address.py b/plugins/modules/gcp_compute_global_address.py index 002c0c5..f308581 100644 --- a/plugins/modules/gcp_compute_global_address.py +++ b/plugins/modules/gcp_compute_global_address.py @@ -72,8 +72,7 @@ options: type: str ip_version: description: - - The IP Version that will be used by this address. Valid options are `IPV4` or - `IPV6`. The default value is `IPV4`. + - The IP Version that will be used by this address. The default value is `IPV4`. - 'Some valid choices include: "IPV4", "IPV6"' required: false type: str @@ -87,7 +86,7 @@ options: version_added: '2.9' address_type: description: - - The type of the address to reserve, default is EXTERNAL. + - The type of the address to reserve. - "* EXTERNAL indicates public/external single IP address." - "* INTERNAL indicates internal IP ranges belonging to some network." - 'Some valid choices include: "EXTERNAL", "INTERNAL"' @@ -212,8 +211,7 @@ name: type: str ipVersion: description: - - The IP Version that will be used by this address. Valid options are `IPV4` or - `IPV6`. The default value is `IPV4`. + - The IP Version that will be used by this address. The default value is `IPV4`. returned: success type: str region: @@ -230,7 +228,7 @@ prefixLength: type: int addressType: description: - - The type of the address to reserve, default is EXTERNAL. + - The type of the address to reserve. - "* EXTERNAL indicates public/external single IP address." - "* INTERNAL indicates internal IP ranges belonging to some network." returned: success diff --git a/plugins/modules/gcp_compute_global_address_info.py b/plugins/modules/gcp_compute_global_address_info.py index e445a48..87f9a4e 100644 --- a/plugins/modules/gcp_compute_global_address_info.py +++ b/plugins/modules/gcp_compute_global_address_info.py @@ -145,8 +145,7 @@ resources: type: str ipVersion: description: - - The IP Version that will be used by this address. Valid options are `IPV4` - or `IPV6`. The default value is `IPV4`. + - The IP Version that will be used by this address. The default value is `IPV4`. returned: success type: str region: @@ -163,7 +162,7 @@ resources: type: int addressType: description: - - The type of the address to reserve, default is EXTERNAL. + - The type of the address to reserve. - "* EXTERNAL indicates public/external single IP address." - "* INTERNAL indicates internal IP ranges belonging to some network." returned: success diff --git a/plugins/modules/gcp_compute_global_forwarding_rule.py b/plugins/modules/gcp_compute_global_forwarding_rule.py index ad392b7..5ac3eb1 100644 --- a/plugins/modules/gcp_compute_global_forwarding_rule.py +++ b/plugins/modules/gcp_compute_global_forwarding_rule.py @@ -83,16 +83,14 @@ options: type: str ip_protocol: description: - - The IP protocol to which this rule applies. Valid options are TCP, UDP, ESP, - AH, SCTP or ICMP. When the load balancing scheme is INTERNAL_SELF_MANAGED, only - TCP is valid. + - The IP protocol to which this rule applies. When the load balancing scheme is + INTERNAL_SELF_MANAGED, only TCP is valid. - 'Some valid choices include: "TCP", "UDP", "ESP", "AH", "SCTP", "ICMP"' required: false type: str ip_version: description: - The IP Version that will be used by this global forwarding rule. - - Valid options are IPV4 or IPV6. - 'Some valid choices include: "IPV4", "IPV6"' required: false type: str @@ -363,15 +361,13 @@ IPAddress: type: str IPProtocol: description: - - The IP protocol to which this rule applies. Valid options are TCP, UDP, ESP, AH, - SCTP or ICMP. When the load balancing scheme is INTERNAL_SELF_MANAGED, only TCP - is valid. + - The IP protocol to which this rule applies. When the load balancing scheme is + INTERNAL_SELF_MANAGED, only TCP is valid. returned: success type: str ipVersion: description: - The IP Version that will be used by this global forwarding rule. - - Valid options are IPV4 or IPV6. returned: success type: str loadBalancingScheme: diff --git a/plugins/modules/gcp_compute_global_forwarding_rule_info.py b/plugins/modules/gcp_compute_global_forwarding_rule_info.py index e205f92..f936ed9 100644 --- a/plugins/modules/gcp_compute_global_forwarding_rule_info.py +++ b/plugins/modules/gcp_compute_global_forwarding_rule_info.py @@ -153,15 +153,13 @@ resources: type: str IPProtocol: description: - - The IP protocol to which this rule applies. Valid options are TCP, UDP, ESP, - AH, SCTP or ICMP. When the load balancing scheme is INTERNAL_SELF_MANAGED, - only TCP is valid. + - The IP protocol to which this rule applies. When the load balancing scheme + is INTERNAL_SELF_MANAGED, only TCP is valid. returned: success type: str ipVersion: description: - The IP Version that will be used by this global forwarding rule. - - Valid options are IPV4 or IPV6. returned: success type: str loadBalancingScheme: diff --git a/plugins/modules/gcp_compute_health_check.py b/plugins/modules/gcp_compute_health_check.py index b710295..4bbada8 100644 --- a/plugins/modules/gcp_compute_health_check.py +++ b/plugins/modules/gcp_compute_health_check.py @@ -152,7 +152,7 @@ options: proxy_header: description: - Specifies the type of proxy header to append before sending data to the - backend, either NONE or PROXY_V1. The default is NONE. + backend. - 'Some valid choices include: "NONE", "PROXY_V1"' required: false default: NONE @@ -214,7 +214,7 @@ options: proxy_header: description: - Specifies the type of proxy header to append before sending data to the - backend, either NONE or PROXY_V1. The default is NONE. + backend. - 'Some valid choices include: "NONE", "PROXY_V1"' required: false default: NONE @@ -269,7 +269,7 @@ options: proxy_header: description: - Specifies the type of proxy header to append before sending data to the - backend, either NONE or PROXY_V1. The default is NONE. + backend. - 'Some valid choices include: "NONE", "PROXY_V1"' required: false default: NONE @@ -324,7 +324,7 @@ options: proxy_header: description: - Specifies the type of proxy header to append before sending data to the - backend, either NONE or PROXY_V1. The default is NONE. + backend. - 'Some valid choices include: "NONE", "PROXY_V1"' required: false default: NONE @@ -387,7 +387,7 @@ options: proxy_header: description: - Specifies the type of proxy header to append before sending data to the - backend, either NONE or PROXY_V1. The default is NONE. + backend. - 'Some valid choices include: "NONE", "PROXY_V1"' required: false default: NONE @@ -574,8 +574,7 @@ httpHealthCheck: type: str proxyHeader: description: - - Specifies the type of proxy header to append before sending data to the backend, - either NONE or PROXY_V1. The default is NONE. + - Specifies the type of proxy header to append before sending data to the backend. returned: success type: str portSpecification: @@ -630,8 +629,7 @@ httpsHealthCheck: type: str proxyHeader: description: - - Specifies the type of proxy header to append before sending data to the backend, - either NONE or PROXY_V1. The default is NONE. + - Specifies the type of proxy header to append before sending data to the backend. returned: success type: str portSpecification: @@ -680,8 +678,7 @@ tcpHealthCheck: type: str proxyHeader: description: - - Specifies the type of proxy header to append before sending data to the backend, - either NONE or PROXY_V1. The default is NONE. + - Specifies the type of proxy header to append before sending data to the backend. returned: success type: str portSpecification: @@ -730,8 +727,7 @@ sslHealthCheck: type: str proxyHeader: description: - - Specifies the type of proxy header to append before sending data to the backend, - either NONE or PROXY_V1. The default is NONE. + - Specifies the type of proxy header to append before sending data to the backend. returned: success type: str portSpecification: @@ -786,8 +782,7 @@ http2HealthCheck: type: str proxyHeader: description: - - Specifies the type of proxy header to append before sending data to the backend, - either NONE or PROXY_V1. The default is NONE. + - Specifies the type of proxy header to append before sending data to the backend. returned: success type: str portSpecification: diff --git a/plugins/modules/gcp_compute_health_check_info.py b/plugins/modules/gcp_compute_health_check_info.py index 5aa7d70..5329859 100644 --- a/plugins/modules/gcp_compute_health_check_info.py +++ b/plugins/modules/gcp_compute_health_check_info.py @@ -211,7 +211,7 @@ resources: proxyHeader: description: - Specifies the type of proxy header to append before sending data to the - backend, either NONE or PROXY_V1. The default is NONE. + backend. returned: success type: str portSpecification: @@ -269,7 +269,7 @@ resources: proxyHeader: description: - Specifies the type of proxy header to append before sending data to the - backend, either NONE or PROXY_V1. The default is NONE. + backend. returned: success type: str portSpecification: @@ -322,7 +322,7 @@ resources: proxyHeader: description: - Specifies the type of proxy header to append before sending data to the - backend, either NONE or PROXY_V1. The default is NONE. + backend. returned: success type: str portSpecification: @@ -375,7 +375,7 @@ resources: proxyHeader: description: - Specifies the type of proxy header to append before sending data to the - backend, either NONE or PROXY_V1. The default is NONE. + backend. returned: success type: str portSpecification: @@ -433,7 +433,7 @@ resources: proxyHeader: description: - Specifies the type of proxy header to append before sending data to the - backend, either NONE or PROXY_V1. The default is NONE. + backend. returned: success type: str portSpecification: diff --git a/plugins/modules/gcp_compute_network_endpoint_group.py b/plugins/modules/gcp_compute_network_endpoint_group.py index 361990a..9771000 100644 --- a/plugins/modules/gcp_compute_network_endpoint_group.py +++ b/plugins/modules/gcp_compute_network_endpoint_group.py @@ -73,8 +73,7 @@ options: type: str network_endpoint_type: description: - - Type of network endpoints in this network endpoint group. The only supported - value is GCE_VM_IP_PORT . + - Type of network endpoints in this network endpoint group. - 'Some valid choices include: "GCE_VM_IP_PORT"' required: false default: GCE_VM_IP_PORT @@ -222,8 +221,7 @@ description: type: str networkEndpointType: description: - - Type of network endpoints in this network endpoint group. The only supported value - is GCE_VM_IP_PORT . + - Type of network endpoints in this network endpoint group. returned: success type: str size: diff --git a/plugins/modules/gcp_compute_network_endpoint_group_info.py b/plugins/modules/gcp_compute_network_endpoint_group_info.py index 7c463a4..53d6587 100644 --- a/plugins/modules/gcp_compute_network_endpoint_group_info.py +++ b/plugins/modules/gcp_compute_network_endpoint_group_info.py @@ -141,8 +141,7 @@ resources: type: str networkEndpointType: description: - - Type of network endpoints in this network endpoint group. The only supported - value is GCE_VM_IP_PORT . + - Type of network endpoints in this network endpoint group. returned: success type: str size: diff --git a/plugins/modules/gcp_compute_region_autoscaler.py b/plugins/modules/gcp_compute_region_autoscaler.py index 1f9d400..45878bf 100644 --- a/plugins/modules/gcp_compute_region_autoscaler.py +++ b/plugins/modules/gcp_compute_region_autoscaler.py @@ -148,7 +148,7 @@ options: utilization_target_type: description: - Defines how target utilization value is expressed for a Stackdriver - Monitoring metric. Either GAUGE, DELTA_PER_SECOND, or DELTA_PER_MINUTE. + Monitoring metric. - 'Some valid choices include: "GAUGE", "DELTA_PER_SECOND", "DELTA_PER_MINUTE"' required: false type: str @@ -404,7 +404,7 @@ autoscalingPolicy: utilizationTargetType: description: - Defines how target utilization value is expressed for a Stackdriver Monitoring - metric. Either GAUGE, DELTA_PER_SECOND, or DELTA_PER_MINUTE. + metric. returned: success type: str loadBalancingUtilization: diff --git a/plugins/modules/gcp_compute_region_autoscaler_info.py b/plugins/modules/gcp_compute_region_autoscaler_info.py index bc90fa2..8bf1555 100644 --- a/plugins/modules/gcp_compute_region_autoscaler_info.py +++ b/plugins/modules/gcp_compute_region_autoscaler_info.py @@ -225,7 +225,7 @@ resources: utilizationTargetType: description: - Defines how target utilization value is expressed for a Stackdriver - Monitoring metric. Either GAUGE, DELTA_PER_SECOND, or DELTA_PER_MINUTE. + Monitoring metric. returned: success type: str loadBalancingUtilization: diff --git a/plugins/modules/gcp_compute_region_backend_service.py b/plugins/modules/gcp_compute_region_backend_service.py index f61ab48..c0e08be 100644 --- a/plugins/modules/gcp_compute_region_backend_service.py +++ b/plugins/modules/gcp_compute_region_backend_service.py @@ -58,7 +58,7 @@ options: suboptions: balancing_mode: description: - - Specifies the balancing mode for this backend. Defaults to CONNECTION. + - Specifies the balancing mode for this backend. - 'Some valid choices include: "UTILIZATION", "RATE", "CONNECTION"' required: false default: CONNECTION @@ -185,8 +185,7 @@ options: description: - Indicates what kind of load balancing this regional backend service will be used for. A backend service created for one type of load balancing cannot be - used with the other(s). Must be `INTERNAL` or `INTERNAL_MANAGED`. Defaults to - `INTERNAL`. + used with the other(s). - 'Some valid choices include: "INTERNAL", "INTERNAL_MANAGED"' required: false default: INTERNAL @@ -204,9 +203,8 @@ options: protocol: description: - The protocol this RegionBackendService uses to communicate with backends. - - 'Possible values are HTTP, HTTPS, HTTP2, SSL, TCP, and UDP. The default is HTTP. - **NOTE**: HTTP2 is only valid for beta HTTP/2 load balancer types and may result - in errors if used with the GA API.' + - 'The default is HTTP. **NOTE**: HTTP2 is only valid for beta HTTP/2 load balancer + types and may result in errors if used with the GA API.' - 'Some valid choices include: "HTTP", "HTTPS", "HTTP2", "SSL", "TCP", "UDP"' required: false type: str @@ -331,7 +329,7 @@ backends: contains: balancingMode: description: - - Specifies the balancing mode for this backend. Defaults to CONNECTION. + - Specifies the balancing mode for this backend. returned: success type: str capacityScaler: @@ -470,7 +468,7 @@ loadBalancingScheme: description: - Indicates what kind of load balancing this regional backend service will be used for. A backend service created for one type of load balancing cannot be used with - the other(s). Must be `INTERNAL` or `INTERNAL_MANAGED`. Defaults to `INTERNAL`. + the other(s). returned: success type: str name: @@ -486,9 +484,8 @@ name: protocol: description: - The protocol this RegionBackendService uses to communicate with backends. - - 'Possible values are HTTP, HTTPS, HTTP2, SSL, TCP, and UDP. The default is HTTP. - **NOTE**: HTTP2 is only valid for beta HTTP/2 load balancer types and may result - in errors if used with the GA API.' + - 'The default is HTTP. **NOTE**: HTTP2 is only valid for beta HTTP/2 load balancer + types and may result in errors if used with the GA API.' returned: success type: str sessionAffinity: diff --git a/plugins/modules/gcp_compute_region_backend_service_info.py b/plugins/modules/gcp_compute_region_backend_service_info.py index 25c4b78..0627f35 100644 --- a/plugins/modules/gcp_compute_region_backend_service_info.py +++ b/plugins/modules/gcp_compute_region_backend_service_info.py @@ -126,7 +126,7 @@ resources: contains: balancingMode: description: - - Specifies the balancing mode for this backend. Defaults to CONNECTION. + - Specifies the balancing mode for this backend. returned: success type: str capacityScaler: @@ -268,8 +268,7 @@ resources: description: - Indicates what kind of load balancing this regional backend service will be used for. A backend service created for one type of load balancing cannot - be used with the other(s). Must be `INTERNAL` or `INTERNAL_MANAGED`. Defaults - to `INTERNAL`. + be used with the other(s). returned: success type: str name: @@ -285,9 +284,8 @@ resources: protocol: description: - The protocol this RegionBackendService uses to communicate with backends. - - 'Possible values are HTTP, HTTPS, HTTP2, SSL, TCP, and UDP. The default is - HTTP. **NOTE**: HTTP2 is only valid for beta HTTP/2 load balancer types and - may result in errors if used with the GA API.' + - 'The default is HTTP. **NOTE**: HTTP2 is only valid for beta HTTP/2 load balancer + types and may result in errors if used with the GA API.' returned: success type: str sessionAffinity: diff --git a/plugins/modules/gcp_compute_region_health_check.py b/plugins/modules/gcp_compute_region_health_check.py index 70b958d..536cbe9 100644 --- a/plugins/modules/gcp_compute_region_health_check.py +++ b/plugins/modules/gcp_compute_region_health_check.py @@ -150,7 +150,7 @@ options: proxy_header: description: - Specifies the type of proxy header to append before sending data to the - backend, either NONE or PROXY_V1. The default is NONE. + backend. - 'Some valid choices include: "NONE", "PROXY_V1"' required: false default: NONE @@ -211,7 +211,7 @@ options: proxy_header: description: - Specifies the type of proxy header to append before sending data to the - backend, either NONE or PROXY_V1. The default is NONE. + backend. - 'Some valid choices include: "NONE", "PROXY_V1"' required: false default: NONE @@ -265,7 +265,7 @@ options: proxy_header: description: - Specifies the type of proxy header to append before sending data to the - backend, either NONE or PROXY_V1. The default is NONE. + backend. - 'Some valid choices include: "NONE", "PROXY_V1"' required: false default: NONE @@ -319,7 +319,7 @@ options: proxy_header: description: - Specifies the type of proxy header to append before sending data to the - backend, either NONE or PROXY_V1. The default is NONE. + backend. - 'Some valid choices include: "NONE", "PROXY_V1"' required: false default: NONE @@ -380,7 +380,7 @@ options: proxy_header: description: - Specifies the type of proxy header to append before sending data to the - backend, either NONE or PROXY_V1. The default is NONE. + backend. - 'Some valid choices include: "NONE", "PROXY_V1"' required: false default: NONE @@ -573,8 +573,7 @@ httpHealthCheck: type: str proxyHeader: description: - - Specifies the type of proxy header to append before sending data to the backend, - either NONE or PROXY_V1. The default is NONE. + - Specifies the type of proxy header to append before sending data to the backend. returned: success type: str portSpecification: @@ -629,8 +628,7 @@ httpsHealthCheck: type: str proxyHeader: description: - - Specifies the type of proxy header to append before sending data to the backend, - either NONE or PROXY_V1. The default is NONE. + - Specifies the type of proxy header to append before sending data to the backend. returned: success type: str portSpecification: @@ -679,8 +677,7 @@ tcpHealthCheck: type: str proxyHeader: description: - - Specifies the type of proxy header to append before sending data to the backend, - either NONE or PROXY_V1. The default is NONE. + - Specifies the type of proxy header to append before sending data to the backend. returned: success type: str portSpecification: @@ -729,8 +726,7 @@ sslHealthCheck: type: str proxyHeader: description: - - Specifies the type of proxy header to append before sending data to the backend, - either NONE or PROXY_V1. The default is NONE. + - Specifies the type of proxy header to append before sending data to the backend. returned: success type: str portSpecification: @@ -785,8 +781,7 @@ http2HealthCheck: type: str proxyHeader: description: - - Specifies the type of proxy header to append before sending data to the backend, - either NONE or PROXY_V1. The default is NONE. + - Specifies the type of proxy header to append before sending data to the backend. returned: success type: str portSpecification: diff --git a/plugins/modules/gcp_compute_region_health_check_info.py b/plugins/modules/gcp_compute_region_health_check_info.py index 24dacb3..dd6c982 100644 --- a/plugins/modules/gcp_compute_region_health_check_info.py +++ b/plugins/modules/gcp_compute_region_health_check_info.py @@ -217,7 +217,7 @@ resources: proxyHeader: description: - Specifies the type of proxy header to append before sending data to the - backend, either NONE or PROXY_V1. The default is NONE. + backend. returned: success type: str portSpecification: @@ -275,7 +275,7 @@ resources: proxyHeader: description: - Specifies the type of proxy header to append before sending data to the - backend, either NONE or PROXY_V1. The default is NONE. + backend. returned: success type: str portSpecification: @@ -328,7 +328,7 @@ resources: proxyHeader: description: - Specifies the type of proxy header to append before sending data to the - backend, either NONE or PROXY_V1. The default is NONE. + backend. returned: success type: str portSpecification: @@ -381,7 +381,7 @@ resources: proxyHeader: description: - Specifies the type of proxy header to append before sending data to the - backend, either NONE or PROXY_V1. The default is NONE. + backend. returned: success type: str portSpecification: @@ -439,7 +439,7 @@ resources: proxyHeader: description: - Specifies the type of proxy header to append before sending data to the - backend, either NONE or PROXY_V1. The default is NONE. + backend. returned: success type: str portSpecification: diff --git a/plugins/modules/gcp_compute_reservation.py b/plugins/modules/gcp_compute_reservation.py index 5ba7d62..101539f 100644 --- a/plugins/modules/gcp_compute_reservation.py +++ b/plugins/modules/gcp_compute_reservation.py @@ -135,8 +135,7 @@ options: suboptions: interface: description: - - The disk interface to use for attaching this disk, one of `SCSI` - or `NVME`. The default is `SCSI`. + - The disk interface to use for attaching this disk. - 'Some valid choices include: "SCSI", "NVME"' required: false default: SCSI @@ -325,8 +324,7 @@ specificReservation: contains: interface: description: - - The disk interface to use for attaching this disk, one of `SCSI` or - `NVME`. The default is `SCSI`. + - The disk interface to use for attaching this disk. returned: success type: str diskSizeGb: diff --git a/plugins/modules/gcp_compute_reservation_info.py b/plugins/modules/gcp_compute_reservation_info.py index fd23e00..23267d2 100644 --- a/plugins/modules/gcp_compute_reservation_info.py +++ b/plugins/modules/gcp_compute_reservation_info.py @@ -223,8 +223,7 @@ resources: contains: interface: description: - - The disk interface to use for attaching this disk, one of `SCSI` - or `NVME`. The default is `SCSI`. + - The disk interface to use for attaching this disk. returned: success type: str diskSizeGb: diff --git a/plugins/modules/gcp_compute_resource_policy.py b/plugins/modules/gcp_compute_resource_policy.py index 13f2f64..f90f3d8 100644 --- a/plugins/modules/gcp_compute_resource_policy.py +++ b/plugins/modules/gcp_compute_resource_policy.py @@ -151,7 +151,6 @@ options: description: - Specifies the behavior to apply to scheduled snapshots when the source disk is deleted. - - Valid options are KEEP_AUTO_SNAPSHOTS and APPLY_RETENTION_POLICY . - 'Some valid choices include: "KEEP_AUTO_SNAPSHOTS", "APPLY_RETENTION_POLICY"' required: false default: KEEP_AUTO_SNAPSHOTS @@ -366,7 +365,6 @@ snapshotSchedulePolicy: description: - Specifies the behavior to apply to scheduled snapshots when the source disk is deleted. - - Valid options are KEEP_AUTO_SNAPSHOTS and APPLY_RETENTION_POLICY . returned: success type: str snapshotProperties: diff --git a/plugins/modules/gcp_compute_resource_policy_info.py b/plugins/modules/gcp_compute_resource_policy_info.py index 5923172..bb2e30e 100644 --- a/plugins/modules/gcp_compute_resource_policy_info.py +++ b/plugins/modules/gcp_compute_resource_policy_info.py @@ -217,7 +217,6 @@ resources: description: - Specifies the behavior to apply to scheduled snapshots when the source disk is deleted. - - Valid options are KEEP_AUTO_SNAPSHOTS and APPLY_RETENTION_POLICY . returned: success type: str snapshotProperties: diff --git a/plugins/modules/gcp_compute_router.py b/plugins/modules/gcp_compute_router.py index 80e3a51..cf876d9 100644 --- a/plugins/modules/gcp_compute_router.py +++ b/plugins/modules/gcp_compute_router.py @@ -88,7 +88,6 @@ options: advertise_mode: description: - User-specified flag to indicate which mode to use for advertisement. - - 'Valid values of this enum field are: DEFAULT, CUSTOM .' - 'Some valid choices include: "DEFAULT", "CUSTOM"' required: false default: DEFAULT @@ -257,7 +256,6 @@ bgp: advertiseMode: description: - User-specified flag to indicate which mode to use for advertisement. - - 'Valid values of this enum field are: DEFAULT, CUSTOM .' returned: success type: str advertisedGroups: diff --git a/plugins/modules/gcp_compute_router_info.py b/plugins/modules/gcp_compute_router_info.py index 83167c4..f08d857 100644 --- a/plugins/modules/gcp_compute_router_info.py +++ b/plugins/modules/gcp_compute_router_info.py @@ -163,7 +163,6 @@ resources: advertiseMode: description: - User-specified flag to indicate which mode to use for advertisement. - - 'Valid values of this enum field are: DEFAULT, CUSTOM .' returned: success type: str advertisedGroups: diff --git a/plugins/modules/gcp_compute_ssl_policy.py b/plugins/modules/gcp_compute_ssl_policy.py index ba2cfb1..d24ad21 100644 --- a/plugins/modules/gcp_compute_ssl_policy.py +++ b/plugins/modules/gcp_compute_ssl_policy.py @@ -67,17 +67,15 @@ options: profile: description: - Profile specifies the set of SSL features that can be used by the load balancer - when negotiating SSL with clients. This can be one of `COMPATIBLE`, `MODERN`, - `RESTRICTED`, or `CUSTOM`. If using `CUSTOM`, the set of SSL features to enable - must be specified in the `customFeatures` field. + when negotiating SSL with clients. If using `CUSTOM`, the set of SSL features + to enable must be specified in the `customFeatures` field. - 'Some valid choices include: "COMPATIBLE", "MODERN", "RESTRICTED", "CUSTOM"' required: false type: str min_tls_version: description: - The minimum version of SSL protocol that can be used by the clients to establish - a connection with the load balancer. This can be one of `TLS_1_0`, `TLS_1_1`, - `TLS_1_2`. + a connection with the load balancer. - 'Some valid choices include: "TLS_1_0", "TLS_1_1", "TLS_1_2"' required: false type: str @@ -185,16 +183,14 @@ name: profile: description: - Profile specifies the set of SSL features that can be used by the load balancer - when negotiating SSL with clients. This can be one of `COMPATIBLE`, `MODERN`, - `RESTRICTED`, or `CUSTOM`. If using `CUSTOM`, the set of SSL features to enable - must be specified in the `customFeatures` field. + when negotiating SSL with clients. If using `CUSTOM`, the set of SSL features + to enable must be specified in the `customFeatures` field. returned: success type: str minTlsVersion: description: - The minimum version of SSL protocol that can be used by the clients to establish - a connection with the load balancer. This can be one of `TLS_1_0`, `TLS_1_1`, - `TLS_1_2`. + a connection with the load balancer. returned: success type: str enabledFeatures: diff --git a/plugins/modules/gcp_compute_ssl_policy_info.py b/plugins/modules/gcp_compute_ssl_policy_info.py index 93eb80f..8bdbbe6 100644 --- a/plugins/modules/gcp_compute_ssl_policy_info.py +++ b/plugins/modules/gcp_compute_ssl_policy_info.py @@ -140,16 +140,14 @@ resources: profile: description: - Profile specifies the set of SSL features that can be used by the load balancer - when negotiating SSL with clients. This can be one of `COMPATIBLE`, `MODERN`, - `RESTRICTED`, or `CUSTOM`. If using `CUSTOM`, the set of SSL features to enable - must be specified in the `customFeatures` field. + when negotiating SSL with clients. If using `CUSTOM`, the set of SSL features + to enable must be specified in the `customFeatures` field. returned: success type: str minTlsVersion: description: - The minimum version of SSL protocol that can be used by the clients to establish - a connection with the load balancer. This can be one of `TLS_1_0`, `TLS_1_1`, - `TLS_1_2`. + a connection with the load balancer. returned: success type: str enabledFeatures: diff --git a/plugins/modules/gcp_compute_target_https_proxy.py b/plugins/modules/gcp_compute_target_https_proxy.py index 19ac1f3..f7c2843 100644 --- a/plugins/modules/gcp_compute_target_https_proxy.py +++ b/plugins/modules/gcp_compute_target_https_proxy.py @@ -69,8 +69,7 @@ options: - Specifies the QUIC override policy for this resource. This determines whether the load balancer will attempt to negotiate QUIC with clients or not. Can specify one of NONE, ENABLE, or DISABLE. If NONE is specified, uses the QUIC policy - with no user overrides, which is equivalent to DISABLE. Not specifying this - field is equivalent to specifying NONE. + with no user overrides, which is equivalent to DISABLE. - 'Some valid choices include: "NONE", "ENABLE", "DISABLE"' required: false type: str @@ -283,8 +282,7 @@ quicOverride: - Specifies the QUIC override policy for this resource. This determines whether the load balancer will attempt to negotiate QUIC with clients or not. Can specify one of NONE, ENABLE, or DISABLE. If NONE is specified, uses the QUIC policy with - no user overrides, which is equivalent to DISABLE. Not specifying this field is - equivalent to specifying NONE. + no user overrides, which is equivalent to DISABLE. returned: success type: str sslCertificates: diff --git a/plugins/modules/gcp_compute_target_https_proxy_info.py b/plugins/modules/gcp_compute_target_https_proxy_info.py index 7e93eb6..62143ff 100644 --- a/plugins/modules/gcp_compute_target_https_proxy_info.py +++ b/plugins/modules/gcp_compute_target_https_proxy_info.py @@ -142,8 +142,7 @@ resources: - Specifies the QUIC override policy for this resource. This determines whether the load balancer will attempt to negotiate QUIC with clients or not. Can specify one of NONE, ENABLE, or DISABLE. If NONE is specified, uses the QUIC - policy with no user overrides, which is equivalent to DISABLE. Not specifying - this field is equivalent to specifying NONE. + policy with no user overrides, which is equivalent to DISABLE. returned: success type: str sslCertificates: diff --git a/plugins/modules/gcp_compute_target_ssl_proxy.py b/plugins/modules/gcp_compute_target_ssl_proxy.py index d9d991e..029742f 100644 --- a/plugins/modules/gcp_compute_target_ssl_proxy.py +++ b/plugins/modules/gcp_compute_target_ssl_proxy.py @@ -66,8 +66,7 @@ options: type: str proxy_header: description: - - Specifies the type of proxy header to append before sending data to the backend, - either NONE or PROXY_V1. The default is NONE. + - Specifies the type of proxy header to append before sending data to the backend. - 'Some valid choices include: "NONE", "PROXY_V1"' required: false type: str @@ -270,8 +269,7 @@ name: type: str proxyHeader: description: - - Specifies the type of proxy header to append before sending data to the backend, - either NONE or PROXY_V1. The default is NONE. + - Specifies the type of proxy header to append before sending data to the backend. returned: success type: str service: diff --git a/plugins/modules/gcp_compute_target_ssl_proxy_info.py b/plugins/modules/gcp_compute_target_ssl_proxy_info.py index 38bac51..a284961 100644 --- a/plugins/modules/gcp_compute_target_ssl_proxy_info.py +++ b/plugins/modules/gcp_compute_target_ssl_proxy_info.py @@ -139,8 +139,7 @@ resources: type: str proxyHeader: description: - - Specifies the type of proxy header to append before sending data to the backend, - either NONE or PROXY_V1. The default is NONE. + - Specifies the type of proxy header to append before sending data to the backend. returned: success type: str service: diff --git a/plugins/modules/gcp_compute_target_tcp_proxy.py b/plugins/modules/gcp_compute_target_tcp_proxy.py index 55636d3..52540e9 100644 --- a/plugins/modules/gcp_compute_target_tcp_proxy.py +++ b/plugins/modules/gcp_compute_target_tcp_proxy.py @@ -66,8 +66,7 @@ options: type: str proxy_header: description: - - Specifies the type of proxy header to append before sending data to the backend, - either NONE or PROXY_V1. The default is NONE. + - Specifies the type of proxy header to append before sending data to the backend. - 'Some valid choices include: "NONE", "PROXY_V1"' required: false type: str @@ -214,8 +213,7 @@ name: type: str proxyHeader: description: - - Specifies the type of proxy header to append before sending data to the backend, - either NONE or PROXY_V1. The default is NONE. + - Specifies the type of proxy header to append before sending data to the backend. returned: success type: str service: diff --git a/plugins/modules/gcp_compute_target_tcp_proxy_info.py b/plugins/modules/gcp_compute_target_tcp_proxy_info.py index fcb8f77..40e2ece 100644 --- a/plugins/modules/gcp_compute_target_tcp_proxy_info.py +++ b/plugins/modules/gcp_compute_target_tcp_proxy_info.py @@ -139,8 +139,7 @@ resources: type: str proxyHeader: description: - - Specifies the type of proxy header to append before sending data to the backend, - either NONE or PROXY_V1. The default is NONE. + - Specifies the type of proxy header to append before sending data to the backend. returned: success type: str service: diff --git a/plugins/modules/gcp_dns_managed_zone.py b/plugins/modules/gcp_dns_managed_zone.py index 5439b0b..f7bae6c 100644 --- a/plugins/modules/gcp_dns_managed_zone.py +++ b/plugins/modules/gcp_dns_managed_zone.py @@ -148,7 +148,6 @@ options: description: - 'The zone''s visibility: public zones are exposed to the Internet, while private zones are visible only to Virtual Private Cloud resources.' - - 'Must be one of: `public`, `private`.' - 'Some valid choices include: "private", "public"' required: false default: public @@ -347,7 +346,6 @@ visibility: description: - 'The zone''s visibility: public zones are exposed to the Internet, while private zones are visible only to Virtual Private Cloud resources.' - - 'Must be one of: `public`, `private`.' returned: success type: str privateVisibilityConfig: diff --git a/plugins/modules/gcp_dns_managed_zone_info.py b/plugins/modules/gcp_dns_managed_zone_info.py index 7c51960..37ec752 100644 --- a/plugins/modules/gcp_dns_managed_zone_info.py +++ b/plugins/modules/gcp_dns_managed_zone_info.py @@ -215,7 +215,6 @@ resources: description: - 'The zone''s visibility: public zones are exposed to the Internet, while private zones are visible only to Virtual Private Cloud resources.' - - 'Must be one of: `public`, `private`.' returned: success type: str privateVisibilityConfig: diff --git a/plugins/modules/gcp_redis_instance.py b/plugins/modules/gcp_redis_instance.py index a4db804..8bc2dcb 100644 --- a/plugins/modules/gcp_redis_instance.py +++ b/plugins/modules/gcp_redis_instance.py @@ -63,8 +63,7 @@ options: type: str connect_mode: description: - - The connection mode of the Redis instance. Can be either `DIRECT_PEERING` or - `PRIVATE_SERVICE_ACCESS`. The default connect mode if not provided is `DIRECT_PEERING`. + - The connection mode of the Redis instance. - 'Some valid choices include: "DIRECT_PEERING", "PRIVATE_SERVICE_ACCESS"' required: false default: DIRECT_PEERING @@ -231,8 +230,7 @@ authorizedNetwork: type: str connectMode: description: - - The connection mode of the Redis instance. Can be either `DIRECT_PEERING` or `PRIVATE_SERVICE_ACCESS`. - The default connect mode if not provided is `DIRECT_PEERING`. + - The connection mode of the Redis instance. returned: success type: str createTime: diff --git a/plugins/modules/gcp_redis_instance_info.py b/plugins/modules/gcp_redis_instance_info.py index d96b568..8df1600 100644 --- a/plugins/modules/gcp_redis_instance_info.py +++ b/plugins/modules/gcp_redis_instance_info.py @@ -125,8 +125,7 @@ resources: type: str connectMode: description: - - The connection mode of the Redis instance. Can be either `DIRECT_PEERING` - or `PRIVATE_SERVICE_ACCESS`. The default connect mode if not provided is `DIRECT_PEERING`. + - The connection mode of the Redis instance. returned: success type: str createTime: