Document how numRetries can't be set to 0

Resolves https://github.com/hashicorp/consul/issues/11816 and https://github.com/hashicorp/consul/issues/8516.
pull/16123/head
Luke Kysow 2023-01-31 13:39:03 -08:00 committed by GitHub
parent d53c331a37
commit 55e197fad7
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 5 additions and 3 deletions

View File

@ -699,9 +699,11 @@ spec:
},
{
name: 'NumRetries',
type: 'int: 0',
description:
'The number of times to retry the request when a retryable result occurs.',
type: 'int: 1',
description: {
hcl: 'The number of times to retry the request when a retryable result occurs. This cannot be set to 0 so if you wish to disable retries, unset all other retry settings (`RetryOnConnectFailure`, `RetryOn`, `RetryOnStatusCodes`)',
yaml: 'The number of times to retry the request when a retryable result occurs. This cannot be set to 0 so if you wish to disable retries, unset all other retry settings (`retryOnConnectFailure`, `retryOn`, `retryOnStatusCodes`)',
}
},
{
name: 'RetryOnConnectFailure',