fix doc formatting errors (#4118) (#310)

Co-authored-by: Riley Karson <rileykarson@google.com>
Signed-off-by: Modular Magician <magic-modules@google.com>

Co-authored-by: Riley Karson <rileykarson@google.com>
This commit is contained in:
The Magician 2020-10-16 13:41:31 -07:00 committed by GitHub
commit 3af242d21d
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
16 changed files with 285 additions and 282 deletions

View file

@ -529,26 +529,26 @@ options:
retry_conditions:
description:
- 'Specifies one or more conditions when this retry rule applies.
Valid values are: - 5xx: Loadbalancer will attempt a retry if
Valid values are: * 5xx: Loadbalancer will attempt a retry if
the backend service responds with any 5xx response code, or
if the backend service does not respond at all, example: disconnects,
reset, read timeout, connection failure, and refused streams.'
- "- gateway-error: Similar to 5xx, but only applies to response
- "* gateway-error: Similar to 5xx, but only applies to response
codes 502, 503 or 504."
- "- connect-failure: Loadbalancer will retry on failures connecting
- "* connect-failure: Loadbalancer will retry on failures connecting
to backend services, for example due to connection timeouts."
- "- retriable-4xx: Loadbalancer will retry for retriable 4xx
- "* retriable-4xx: Loadbalancer will retry for retriable 4xx
response codes."
- Currently the only retriable error supported is 409.
- "- refused-stream: Loadbalancer will retry if the backend service
- "* refused-stream: Loadbalancer will retry if the backend service
resets the stream with a REFUSED_STREAM error code. This reset
type indicates that it is safe to retry."
- "- cancelled: Loadbalancer will retry if the gRPC status code
in the response header is set to cancelled - deadline-exceeded:
- "* cancelled: Loadbalancer will retry if the gRPC status code
in the response header is set to cancelled * deadline-exceeded:
Loadbalancer will retry if the gRPC status code in the response
header is set to deadline-exceeded - resource-exhausted: Loadbalancer
header is set to deadline-exceeded * resource-exhausted: Loadbalancer
will retry if the gRPC status code in the response header is
set to resource-exhausted - unavailable: Loadbalancer will retry
set to resource-exhausted * unavailable: Loadbalancer will retry
if the gRPC status code in the response header is set to unavailable
."
elements: str
@ -1324,26 +1324,26 @@ options:
retry_conditions:
description:
- 'Specfies one or more conditions when this retry rule applies.
Valid values are: - 5xx: Loadbalancer will attempt a retry if
Valid values are: * 5xx: Loadbalancer will attempt a retry if
the backend service responds with any 5xx response code, or
if the backend service does not respond at all, example: disconnects,
reset, read timeout, connection failure, and refused streams.'
- "- gateway-error: Similar to 5xx, but only applies to response
- "* gateway-error: Similar to 5xx, but only applies to response
codes 502, 503 or 504."
- "- connect-failure: Loadbalancer will retry on failures connecting
- "* connect-failure: Loadbalancer will retry on failures connecting
to backend services, for example due to connection timeouts."
- "- retriable-4xx: Loadbalancer will retry for retriable 4xx
- "* retriable-4xx: Loadbalancer will retry for retriable 4xx
response codes."
- Currently the only retriable error supported is 409.
- "- refused-stream: Loadbalancer will retry if the backend service
- "* refused-stream: Loadbalancer will retry if the backend service
resets the stream with a REFUSED_STREAM error code. This reset
type indicates that it is safe to retry."
- "- cancelled: Loadbalancer will retry if the gRPC status code
in the response header is set to cancelled - deadline-exceeded:
- "* cancelled: Loadbalancer will retry if the gRPC status code
in the response header is set to cancelled * deadline-exceeded:
Loadbalancer will retry if the gRPC status code in the response
header is set to deadline-exceeded - resource-exhausted: Loadbalancer
header is set to deadline-exceeded * resource-exhausted: Loadbalancer
will retry if the gRPC status code in the response header is
set to resource-exhausted - unavailable: Loadbalancer will retry
set to resource-exhausted * unavailable: Loadbalancer will retry
if the gRPC status code in the response header is set to unavailable
."
elements: str
@ -1827,27 +1827,27 @@ options:
retry_conditions:
description:
- 'Specfies one or more conditions when this retry rule applies. Valid
values are: 5xx: Loadbalancer will attempt a retry if the backend
values are: * 5xx: Loadbalancer will attempt a retry if the backend
service responds with any 5xx response code, or if the backend service
does not respond at all, example: disconnects, reset, read timeout,
connection failure, and refused streams.'
- 'gateway-error: Similar to 5xx, but only applies to response codes
502, 503 or 504.'
- 'connect-failure: Loadbalancer will retry on failures connecting
to backend services, for example due to connection timeouts.'
- 'retriable-4xx: Loadbalancer will retry for retriable 4xx response
codes.'
* connection failure, and refused streams.'
- "* gateway-error: Similar to 5xx, but only applies to response codes
502, 503 or 504."
- "* connect-failure: Loadbalancer will retry on failures connecting
to backend services, for example due to connection timeouts."
- "* retriable-4xx: Loadbalancer will retry for retriable 4xx response
codes."
- Currently the only retriable error supported is 409.
- refused-stream:Loadbalancer will retry if the backend service resets
the stream with a REFUSED_STREAM error code.
- "* refused-stream:Loadbalancer will retry if the backend service
resets the stream with a REFUSED_STREAM error code."
- This reset type indicates that it is safe to retry.
- 'cancelled: Loadbalancer will retry if the gRPC status code in the
response header is set to cancelled deadline-exceeded: Loadbalancer
- "* cancelled: Loadbalancer will retry if the gRPC status code in
the response header is set to cancelled * deadline-exceeded: Loadbalancer
will retry if the gRPC status code in the response header is set
to deadline-exceeded resource-exhausted: Loadbalancer will retry
to deadline-exceeded * resource-exhausted: Loadbalancer will retry
if the gRPC status code in the response header is set to resource-exhausted
unavailable: Loadbalancer will retry if the gRPC status code in
the response header is set to unavailable .'
* unavailable: Loadbalancer will retry if the gRPC status code in
the response header is set to unavailable ."
elements: str
required: false
type: list
@ -2324,26 +2324,27 @@ options:
retry_conditions:
description:
- 'Specfies one or more conditions when this retry rule applies. Valid
values are: 5xx: Loadbalancer will attempt a retry if the backend service
responds with any 5xx response code, or if the backend service does
not respond at all, example: disconnects, reset, read timeout, connection
failure, and refused streams.'
- 'gateway-error: Similar to 5xx, but only applies to response codes 502,
503 or 504.'
- 'connect-failure: Loadbalancer will retry on failures connecting to
backend services, for example due to connection timeouts.'
- 'retriable-4xx: Loadbalancer will retry for retriable 4xx response codes.'
values are: * 5xx: Loadbalancer will attempt a retry if the backend
service responds with any 5xx response code, or if the backend service
does not respond at all, example: disconnects, reset, read timeout,
* connection failure, and refused streams.'
- "* gateway-error: Similar to 5xx, but only applies to response codes
502, 503 or 504."
- "* connect-failure: Loadbalancer will retry on failures connecting to
backend services, for example due to connection timeouts."
- "* retriable-4xx: Loadbalancer will retry for retriable 4xx response
codes."
- Currently the only retriable error supported is 409.
- refused-stream:Loadbalancer will retry if the backend service resets
the stream with a REFUSED_STREAM error code.
- "* refused-stream:Loadbalancer will retry if the backend service resets
the stream with a REFUSED_STREAM error code."
- This reset type indicates that it is safe to retry.
- 'cancelled: Loadbalancer will retry if the gRPC status code in the response
header is set to cancelled deadline-exceeded: Loadbalancer will retry
if the gRPC status code in the response header is set to deadline-exceeded
resource-exhausted: Loadbalancer will retry if the gRPC status code
in the response header is set to resource-exhausted unavailable: Loadbalancer
- "* cancelled: Loadbalancer will retry if the gRPC status code in the
response header is set to cancelled * deadline-exceeded: Loadbalancer
will retry if the gRPC status code in the response header is set to
unavailable .'
deadline-exceeded * resource-exhausted: Loadbalancer will retry if the
gRPC status code in the response header is set to resource-exhausted
* unavailable: Loadbalancer will retry if the gRPC status code in the
response header is set to unavailable ."
elements: str
required: false
type: list
@ -3086,26 +3087,26 @@ pathMatchers:
retryConditions:
description:
- 'Specifies one or more conditions when this retry rule applies.
Valid values are: - 5xx: Loadbalancer will attempt a retry if
Valid values are: * 5xx: Loadbalancer will attempt a retry if
the backend service responds with any 5xx response code, or if
the backend service does not respond at all, example: disconnects,
reset, read timeout, connection failure, and refused streams.'
- "- gateway-error: Similar to 5xx, but only applies to response
- "* gateway-error: Similar to 5xx, but only applies to response
codes 502, 503 or 504."
- "- connect-failure: Loadbalancer will retry on failures connecting
- "* connect-failure: Loadbalancer will retry on failures connecting
to backend services, for example due to connection timeouts."
- "- retriable-4xx: Loadbalancer will retry for retriable 4xx response
- "* retriable-4xx: Loadbalancer will retry for retriable 4xx response
codes."
- Currently the only retriable error supported is 409.
- "- refused-stream: Loadbalancer will retry if the backend service
- "* refused-stream: Loadbalancer will retry if the backend service
resets the stream with a REFUSED_STREAM error code. This reset
type indicates that it is safe to retry."
- "- cancelled: Loadbalancer will retry if the gRPC status code
in the response header is set to cancelled - deadline-exceeded:
- "* cancelled: Loadbalancer will retry if the gRPC status code
in the response header is set to cancelled * deadline-exceeded:
Loadbalancer will retry if the gRPC status code in the response
header is set to deadline-exceeded - resource-exhausted: Loadbalancer
header is set to deadline-exceeded * resource-exhausted: Loadbalancer
will retry if the gRPC status code in the response header is set
to resource-exhausted - unavailable: Loadbalancer will retry if
to resource-exhausted * unavailable: Loadbalancer will retry if
the gRPC status code in the response header is set to unavailable
."
returned: success
@ -3825,26 +3826,26 @@ pathMatchers:
retryConditions:
description:
- 'Specfies one or more conditions when this retry rule applies.
Valid values are: - 5xx: Loadbalancer will attempt a retry if
Valid values are: * 5xx: Loadbalancer will attempt a retry if
the backend service responds with any 5xx response code, or if
the backend service does not respond at all, example: disconnects,
reset, read timeout, connection failure, and refused streams.'
- "- gateway-error: Similar to 5xx, but only applies to response
- "* gateway-error: Similar to 5xx, but only applies to response
codes 502, 503 or 504."
- "- connect-failure: Loadbalancer will retry on failures connecting
- "* connect-failure: Loadbalancer will retry on failures connecting
to backend services, for example due to connection timeouts."
- "- retriable-4xx: Loadbalancer will retry for retriable 4xx response
- "* retriable-4xx: Loadbalancer will retry for retriable 4xx response
codes."
- Currently the only retriable error supported is 409.
- "- refused-stream: Loadbalancer will retry if the backend service
- "* refused-stream: Loadbalancer will retry if the backend service
resets the stream with a REFUSED_STREAM error code. This reset
type indicates that it is safe to retry."
- "- cancelled: Loadbalancer will retry if the gRPC status code
in the response header is set to cancelled - deadline-exceeded:
- "* cancelled: Loadbalancer will retry if the gRPC status code
in the response header is set to cancelled * deadline-exceeded:
Loadbalancer will retry if the gRPC status code in the response
header is set to deadline-exceeded - resource-exhausted: Loadbalancer
header is set to deadline-exceeded * resource-exhausted: Loadbalancer
will retry if the gRPC status code in the response header is set
to resource-exhausted - unavailable: Loadbalancer will retry if
to resource-exhausted * unavailable: Loadbalancer will retry if
the gRPC status code in the response header is set to unavailable
."
returned: success
@ -4292,27 +4293,27 @@ pathMatchers:
retryConditions:
description:
- 'Specfies one or more conditions when this retry rule applies. Valid
values are: 5xx: Loadbalancer will attempt a retry if the backend
values are: * 5xx: Loadbalancer will attempt a retry if the backend
service responds with any 5xx response code, or if the backend service
does not respond at all, example: disconnects, reset, read timeout,
connection failure, and refused streams.'
- 'gateway-error: Similar to 5xx, but only applies to response codes
502, 503 or 504.'
- 'connect-failure: Loadbalancer will retry on failures connecting to
backend services, for example due to connection timeouts.'
- 'retriable-4xx: Loadbalancer will retry for retriable 4xx response
codes.'
* connection failure, and refused streams.'
- "* gateway-error: Similar to 5xx, but only applies to response codes
502, 503 or 504."
- "* connect-failure: Loadbalancer will retry on failures connecting
to backend services, for example due to connection timeouts."
- "* retriable-4xx: Loadbalancer will retry for retriable 4xx response
codes."
- Currently the only retriable error supported is 409.
- refused-stream:Loadbalancer will retry if the backend service resets
the stream with a REFUSED_STREAM error code.
- "* refused-stream:Loadbalancer will retry if the backend service resets
the stream with a REFUSED_STREAM error code."
- This reset type indicates that it is safe to retry.
- 'cancelled: Loadbalancer will retry if the gRPC status code in the
response header is set to cancelled deadline-exceeded: Loadbalancer
- "* cancelled: Loadbalancer will retry if the gRPC status code in the
response header is set to cancelled * deadline-exceeded: Loadbalancer
will retry if the gRPC status code in the response header is set to
deadline-exceeded resource-exhausted: Loadbalancer will retry if the
gRPC status code in the response header is set to resource-exhausted
unavailable: Loadbalancer will retry if the gRPC status code in the
response header is set to unavailable .'
deadline-exceeded * resource-exhausted: Loadbalancer will retry if
the gRPC status code in the response header is set to resource-exhausted
* unavailable: Loadbalancer will retry if the gRPC status code in
the response header is set to unavailable ."
returned: success
type: list
numRetries:
@ -4748,26 +4749,26 @@ defaultRouteAction:
retryConditions:
description:
- 'Specfies one or more conditions when this retry rule applies. Valid values
are: 5xx: Loadbalancer will attempt a retry if the backend service responds
are: * 5xx: Loadbalancer will attempt a retry if the backend service responds
with any 5xx response code, or if the backend service does not respond
at all, example: disconnects, reset, read timeout, connection failure,
at all, example: disconnects, reset, read timeout, * connection failure,
and refused streams.'
- 'gateway-error: Similar to 5xx, but only applies to response codes 502,
503 or 504.'
- 'connect-failure: Loadbalancer will retry on failures connecting to backend
services, for example due to connection timeouts.'
- 'retriable-4xx: Loadbalancer will retry for retriable 4xx response codes.'
- "* gateway-error: Similar to 5xx, but only applies to response codes 502,
503 or 504."
- "* connect-failure: Loadbalancer will retry on failures connecting to
backend services, for example due to connection timeouts."
- "* retriable-4xx: Loadbalancer will retry for retriable 4xx response codes."
- Currently the only retriable error supported is 409.
- refused-stream:Loadbalancer will retry if the backend service resets the
stream with a REFUSED_STREAM error code.
- "* refused-stream:Loadbalancer will retry if the backend service resets
the stream with a REFUSED_STREAM error code."
- This reset type indicates that it is safe to retry.
- 'cancelled: Loadbalancer will retry if the gRPC status code in the response
header is set to cancelled deadline-exceeded: Loadbalancer will retry
- "* cancelled: Loadbalancer will retry if the gRPC status code in the response
header is set to cancelled * deadline-exceeded: Loadbalancer will retry
if the gRPC status code in the response header is set to deadline-exceeded
resource-exhausted: Loadbalancer will retry if the gRPC status code in
the response header is set to resource-exhausted unavailable: Loadbalancer
* resource-exhausted: Loadbalancer will retry if the gRPC status code
in the response header is set to resource-exhausted * unavailable: Loadbalancer
will retry if the gRPC status code in the response header is set to unavailable
.'
."
returned: success
type: list
numRetries: