From f9ff2234915a1581d5e770359945b0503596e4f6 Mon Sep 17 00:00:00 2001 From: Traky Deng Date: Wed, 22 Oct 2025 10:43:00 +0800 Subject: [PATCH] docs: remove a link from CRD docs (#2611) (cherry picked from commit 0f702bd99d1124fff7ba0799732ffe0fb0239ffb) --- api/v2/apisixupstream_types.go | 2 -- .../apisix.apache.org_apisixupstreams.yaml | 18 ++++++------------ docs/en/latest/reference/api-reference.md | 4 ++-- 3 files changed, 8 insertions(+), 16 deletions(-) diff --git a/api/v2/apisixupstream_types.go b/api/v2/apisixupstream_types.go index 73a925be..245c2d0e 100644 --- a/api/v2/apisixupstream_types.go +++ b/api/v2/apisixupstream_types.go @@ -314,8 +314,6 @@ type PassiveHealthCheckUnhealthy struct { // TCPFailures define the number of TCP failures to define an unhealthy target. TCPFailures int `json:"tcpFailures,omitempty" yaml:"tcpFailures,omitempty"` // Timeout sets health check timeout in seconds. - // https://github.com/apache/apisix/blob/0151d9e35bba63d7c316187272d88e19db0be634/apisix/schema_def.lua#L196 - // // +kubebuilder:validation:Minimum=1 // +kubebuilder:validation:Maximum=254 Timeouts int `json:"timeout,omitempty" yaml:"timeout,omitempty"` diff --git a/config/crd/bases/apisix.apache.org_apisixupstreams.yaml b/config/crd/bases/apisix.apache.org_apisixupstreams.yaml index fdded278..56284c31 100644 --- a/config/crd/bases/apisix.apache.org_apisixupstreams.yaml +++ b/config/crd/bases/apisix.apache.org_apisixupstreams.yaml @@ -190,9 +190,7 @@ spec: minimum: 0 type: integer timeout: - description: |- - Timeout sets health check timeout in seconds. - https://github.com/apache/apisix/blob/0151d9e35bba63d7c316187272d88e19db0be634/apisix/schema_def.lua#L196 + description: Timeout sets health check timeout in seconds. maximum: 254 minimum: 1 type: integer @@ -254,9 +252,7 @@ spec: minimum: 0 type: integer timeout: - description: |- - Timeout sets health check timeout in seconds. - https://github.com/apache/apisix/blob/0151d9e35bba63d7c316187272d88e19db0be634/apisix/schema_def.lua#L196 + description: Timeout sets health check timeout in seconds. maximum: 254 minimum: 1 type: integer @@ -451,9 +447,8 @@ spec: minimum: 0 type: integer timeout: - description: |- - Timeout sets health check timeout in seconds. - https://github.com/apache/apisix/blob/0151d9e35bba63d7c316187272d88e19db0be634/apisix/schema_def.lua#L196 + description: Timeout sets health check timeout in + seconds. maximum: 254 minimum: 1 type: integer @@ -515,9 +510,8 @@ spec: minimum: 0 type: integer timeout: - description: |- - Timeout sets health check timeout in seconds. - https://github.com/apache/apisix/blob/0151d9e35bba63d7c316187272d88e19db0be634/apisix/schema_def.lua#L196 + description: Timeout sets health check timeout in + seconds. maximum: 254 minimum: 1 type: integer diff --git a/docs/en/latest/reference/api-reference.md b/docs/en/latest/reference/api-reference.md index 7bfeb239..64b977a5 100644 --- a/docs/en/latest/reference/api-reference.md +++ b/docs/en/latest/reference/api-reference.md @@ -661,7 +661,7 @@ UpstreamActiveHealthCheckHealthy defines the conditions used to actively determi | `httpCodes` _integer array_ | HTTPCodes define a list of HTTP status codes that are considered unhealthy. | | `httpFailures` _integer_ | HTTPFailures define the number of HTTP failures to define an unhealthy target. | | `tcpFailures` _integer_ | TCPFailures define the number of TCP failures to define an unhealthy target. | -| `timeout` _integer_ | Timeout sets health check timeout in seconds. https://github.com/apache/apisix/blob/0151d9e35bba63d7c316187272d88e19db0be634/apisix/schema_def.lua#L196 | +| `timeout` _integer_ | Timeout sets health check timeout in seconds. | | `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. | @@ -1528,7 +1528,7 @@ UpstreamPassiveHealthCheckUnhealthy defines the conditions used to passively det | `httpCodes` _integer array_ | HTTPCodes define a list of HTTP status codes that are considered unhealthy. | | `httpFailures` _integer_ | HTTPFailures define the number of HTTP failures to define an unhealthy target. | | `tcpFailures` _integer_ | TCPFailures define the number of TCP failures to define an unhealthy target. | -| `timeout` _integer_ | Timeout sets health check timeout in seconds. https://github.com/apache/apisix/blob/0151d9e35bba63d7c316187272d88e19db0be634/apisix/schema_def.lua#L196 | +| `timeout` _integer_ | Timeout sets health check timeout in seconds. | _Appears in:_