docs: update CRD docs #192
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
conformance test report - apisix modeapiVersion: gateway.networking.k8s.io/v1
date: "2025-07-04T09:06:03Z"
gatewayAPIChannel: standard
gatewayAPIVersion: v1.2.0
implementation:
contact: null
organization: APISIX
project: apisix-ingress-controller
url: https://github.com/apache/apisix-ingress-controller.git
version: v2.0.0
kind: ConformanceReport
mode: default
profiles:
- core:
failedTests:
- HTTPRouteCrossNamespace
- HTTPRouteMatchingAcrossRoutes
result: failure
skippedTests:
- HTTPRouteHTTPSListener
statistics:
Failed: 2
Passed: 30
Skipped: 1
name: GATEWAY-HTTP
summary: Core tests failed with 2 test failures. |
conformance test reportapiVersion: gateway.networking.k8s.io/v1
date: "2025-07-16T02:55:18Z"
gatewayAPIChannel: standard
gatewayAPIVersion: v1.2.0
implementation:
contact: null
organization: APISIX
project: apisix-ingress-controller
url: https://github.com/apache/apisix-ingress-controller.git
version: v2.0.0
kind: ConformanceReport
mode: default
profiles:
- core:
result: partial
skippedTests:
- HTTPRouteHTTPSListener
statistics:
Failed: 0
Passed: 32
Skipped: 1
name: GATEWAY-HTTP
summary: Core tests partially succeeded with 1 test skips. |
kayx23
commented
Jul 4, 2025
|
|
||
| // FilterFunc is a user-defined function for advanced request filtering. | ||
| // The function can use Nginx variables through the `vars` parameter. | ||
| // This field is supported in APISIX but not in API7 Enterprise. | ||
| FilterFunc string `json:"filter_func,omitempty" yaml:"filter_func,omitempty"` |
There was a problem hiding this comment.
This field is supported in APISIX but not in API7 Enterprise.
cc: @oil-oil as discussed yesterday, filter_func
|
HMAC related docs are not updated (and not marked yet). There was a breaking change and APISIX CRD docs generated for hmac-auth is not applicable for either APISIX or Enterprise. R&D to remove HMAC - since the change is not just a documentary change. discussion: https://applink.feishu.cn/client/message/link/open?token=AmgIUwWIYsABaG8vyr4BgAQ%3D |
|
One issue: The generated doc has a non-clickable link rendered in markdown: 
I think its due to this line:
Might need to manually replace at the moment or update the template. |
conformance test report - apisix modeapiVersion: gateway.networking.k8s.io/v1
date: "2025-07-16T02:51:24Z"
gatewayAPIChannel: standard
gatewayAPIVersion: v1.2.0
implementation:
contact: null
organization: APISIX
project: apisix-ingress-controller
url: https://github.com/apache/apisix-ingress-controller.git
version: v2.0.0
kind: ConformanceReport
mode: default
profiles:
- core:
failedTests:
- HTTPRouteInvalidBackendRefUnknownKind
result: failure
skippedTests:
- HTTPRouteHTTPSListener
statistics:
Failed: 1
Passed: 31
Skipped: 1
name: GATEWAY-HTTP
summary: Core tests failed with 1 test failures. |
conformance test report - apisix-standalone modeapiVersion: gateway.networking.k8s.io/v1
date: "2025-07-16T02:50:24Z"
gatewayAPIChannel: standard
gatewayAPIVersion: v1.2.0
implementation:
contact: null
organization: APISIX
project: apisix-ingress-controller
url: https://github.com/apache/apisix-ingress-controller.git
version: v2.0.0
kind: ConformanceReport
mode: default
profiles:
- core:
failedTests:
- HTTPRouteInvalidBackendRefUnknownKind
result: failure
skippedTests:
- HTTPRouteHTTPSListener
statistics:
Failed: 1
Passed: 31
Skipped: 1
name: GATEWAY-HTTP
summary: Core tests failed with 1 test failures. |
AlinsRan
reviewed
Jul 9, 2025
AlinsRan
reviewed
Jul 9, 2025
Signed-off-by: ashing <[email protected]>
ronething
approved these changes
Jul 16, 2025
AlinsRan
approved these changes
Jul 16, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
HMAC related docs are not updated. See: #192 (comment)
Type of change