Skip to content

Commit 849987d

Browse files
docs: remove a link from CRD docs (#2611) (#316)
Co-authored-by: Traky Deng <[email protected]>
1 parent 14faafe commit 849987d

File tree

3 files changed

+8
-16
lines changed

3 files changed

+8
-16
lines changed

api/v2/apisixupstream_types.go

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -314,8 +314,6 @@ type PassiveHealthCheckUnhealthy struct {
314314
// TCPFailures define the number of TCP failures to define an unhealthy target.
315315
TCPFailures int `json:"tcpFailures,omitempty" yaml:"tcpFailures,omitempty"`
316316
// Timeout sets health check timeout in seconds.
317-
// https://github.com/apache/apisix/blob/0151d9e35bba63d7c316187272d88e19db0be634/apisix/schema_def.lua#L196
318-
//
319317
// +kubebuilder:validation:Minimum=1
320318
// +kubebuilder:validation:Maximum=254
321319
Timeouts int `json:"timeout,omitempty" yaml:"timeout,omitempty"`

config/crd/bases/apisix.apache.org_apisixupstreams.yaml

Lines changed: 6 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -190,9 +190,7 @@ spec:
190190
minimum: 0
191191
type: integer
192192
timeout:
193-
description: |-
194-
Timeout sets health check timeout in seconds.
195-
https://github.com/apache/apisix/blob/0151d9e35bba63d7c316187272d88e19db0be634/apisix/schema_def.lua#L196
193+
description: Timeout sets health check timeout in seconds.
196194
maximum: 254
197195
minimum: 1
198196
type: integer
@@ -254,9 +252,7 @@ spec:
254252
minimum: 0
255253
type: integer
256254
timeout:
257-
description: |-
258-
Timeout sets health check timeout in seconds.
259-
https://github.com/apache/apisix/blob/0151d9e35bba63d7c316187272d88e19db0be634/apisix/schema_def.lua#L196
255+
description: Timeout sets health check timeout in seconds.
260256
maximum: 254
261257
minimum: 1
262258
type: integer
@@ -451,9 +447,8 @@ spec:
451447
minimum: 0
452448
type: integer
453449
timeout:
454-
description: |-
455-
Timeout sets health check timeout in seconds.
456-
https://github.com/apache/apisix/blob/0151d9e35bba63d7c316187272d88e19db0be634/apisix/schema_def.lua#L196
450+
description: Timeout sets health check timeout in
451+
seconds.
457452
maximum: 254
458453
minimum: 1
459454
type: integer
@@ -515,9 +510,8 @@ spec:
515510
minimum: 0
516511
type: integer
517512
timeout:
518-
description: |-
519-
Timeout sets health check timeout in seconds.
520-
https://github.com/apache/apisix/blob/0151d9e35bba63d7c316187272d88e19db0be634/apisix/schema_def.lua#L196
513+
description: Timeout sets health check timeout in
514+
seconds.
521515
maximum: 254
522516
minimum: 1
523517
type: integer

docs/en/latest/reference/api-reference.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -661,7 +661,7 @@ UpstreamActiveHealthCheckHealthy defines the conditions used to actively determi
661661
| `httpCodes` _integer array_ | HTTPCodes define a list of HTTP status codes that are considered unhealthy. |
662662
| `httpFailures` _integer_ | HTTPFailures define the number of HTTP failures to define an unhealthy target. |
663663
| `tcpFailures` _integer_ | TCPFailures define the number of TCP failures to define an unhealthy target. |
664-
| `timeout` _integer_ | Timeout sets health check timeout in seconds. https://github.com/apache/apisix/blob/0151d9e35bba63d7c316187272d88e19db0be634/apisix/schema_def.lua#L196 |
664+
| `timeout` _integer_ | Timeout sets health check timeout in seconds. |
665665
| `interval` _[Duration](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.30/#duration-v1-meta)_ | Interval defines the time interval for checking targets, in seconds. |
666666

667667

@@ -1528,7 +1528,7 @@ UpstreamPassiveHealthCheckUnhealthy defines the conditions used to passively det
15281528
| `httpCodes` _integer array_ | HTTPCodes define a list of HTTP status codes that are considered unhealthy. |
15291529
| `httpFailures` _integer_ | HTTPFailures define the number of HTTP failures to define an unhealthy target. |
15301530
| `tcpFailures` _integer_ | TCPFailures define the number of TCP failures to define an unhealthy target. |
1531-
| `timeout` _integer_ | Timeout sets health check timeout in seconds. https://github.com/apache/apisix/blob/0151d9e35bba63d7c316187272d88e19db0be634/apisix/schema_def.lua#L196 |
1531+
| `timeout` _integer_ | Timeout sets health check timeout in seconds. |
15321532

15331533

15341534
_Appears in:_

0 commit comments

Comments
 (0)