Documentation Refactor

2025-06-02 23:19:11 -07:00 · 2018-10-23 11:40:07 -07:00 · 2018-10-23 11:40:07 -07:00 · 87656c4016
commit 87656c4016
parent 6a98471a53
88 changed files with 11960 additions and 12598 deletions
--- a/plugins/modules/gcp_compute_https_health_check.py
+++ b/plugins/modules/gcp_compute_https_health_check.py
@ -102,7 +102,7 @@ options:
    required: false
 extends_documentation_fragment: gcp
 notes:
- 'API Reference: U(https://cloud.google.com/compute/docs/reference/v1/httpsHealthChecks)'
+- 'API Reference: U(https://cloud.google.com/compute/docs/reference/latest/httpsHealthChecks)'
 - 'Adding Health Checks: U(https://cloud.google.com/compute/docs/load-balancing/health-checks#legacy_health_checks)'
 '''

@ -121,75 +121,75 @@ EXAMPLES = '''
 '''

 RETURN = '''
-    checkIntervalSec:
-        description:
-            - How often (in seconds) to send a health check. The default value is 5 seconds.
-        returned: success
-        type: int
-    creationTimestamp:
-        description:
-            - Creation timestamp in RFC3339 text format.
-        returned: success
-        type: str
-    description:
-        description:
-            - An optional description of this resource. Provide this property when you create
-              the resource.
-        returned: success
-        type: str
-    healthyThreshold:
-        description:
-            - A so-far unhealthy instance will be marked healthy after this many consecutive successes.
-              The default value is 2.
-        returned: success
-        type: int
-    host:
-        description:
-            - The value of the host header in the HTTPS health check request. If left empty (default
-              value), the public IP on behalf of which this health check is performed will be
-              used.
-        returned: success
-        type: str
-    id:
-        description:
-            - The unique identifier for the resource. This identifier is defined by the server.
-        returned: success
-        type: int
-    name:
-        description:
-            - Name of the resource. Provided by the client when the resource is created. The name
-              must be 1-63 characters long, and comply with RFC1035.  Specifically, the name must
-              be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?`
-              which means the first character must be a lowercase letter, and all following characters
-              must be a dash, lowercase letter, or digit, except the last character, which cannot
-              be a dash.
-        returned: success
-        type: str
-    port:
-        description:
-            - The TCP port number for the HTTPS health check request.
-            - The default value is 80.
-        returned: success
-        type: int
-    requestPath:
-        description:
-            - The request path of the HTTPS health check request.
-            - The default value is /.
-        returned: success
-        type: str
-    timeoutSec:
-        description:
-            - How long (in seconds) to wait before claiming failure.
-            - The default value is 5 seconds.  It is invalid for timeoutSec to have greater value
-              than checkIntervalSec.
-        returned: success
-        type: int
-    unhealthyThreshold:
-        description:
-            - A so-far healthy instance will be marked unhealthy after this many consecutive failures.
-              The default value is 2.
-        returned: success
-        type: int
+checkIntervalSec:
+  description:
+  - How often (in seconds) to send a health check. The default value is 5 seconds.
+  returned: success
+  type: int
+creationTimestamp:
+  description:
+  - Creation timestamp in RFC3339 text format.
+  returned: success
+  type: str
+description:
+  description:
+  - An optional description of this resource. Provide this property when you create
+    the resource.
+  returned: success
+  type: str
+healthyThreshold:
+  description:
+  - A so-far unhealthy instance will be marked healthy after this many consecutive
+    successes. The default value is 2.
+  returned: success
+  type: int
+host:
+  description:
+  - The value of the host header in the HTTPS health check request. If left empty
+    (default value), the public IP on behalf of which this health check is performed
+    will be used.
+  returned: success
+  type: str
+id:
+  description:
+  - The unique identifier for the resource. This identifier is defined by the server.
+  returned: success
+  type: int
+name:
+  description:
+  - Name of the resource. Provided by the client when the resource is created. The
+    name must be 1-63 characters long, and comply with RFC1035. Specifically, the
+    name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?`
+    which means the first character must be a lowercase letter, and all following
+    characters must be a dash, lowercase letter, or digit, except the last character,
+    which cannot be a dash.
+  returned: success
+  type: str
+port:
+  description:
+  - The TCP port number for the HTTPS health check request.
+  - The default value is 80.
+  returned: success
+  type: int
+requestPath:
+  description:
+  - The request path of the HTTPS health check request.
+  - The default value is /.
+  returned: success
+  type: str
+timeoutSec:
+  description:
+  - How long (in seconds) to wait before claiming failure.
+  - The default value is 5 seconds. It is invalid for timeoutSec to have greater value
+    than checkIntervalSec.
+  returned: success
+  type: int
+unhealthyThreshold:
+  description:
+  - A so-far healthy instance will be marked unhealthy after this many consecutive
+    failures. The default value is 2.
+  returned: success
+  type: int
 '''

 ################################################################################