Skip to content

fix(standalone): lack of configuration validation in api#12424

Merged
AlinsRan merged 13 commits into
apache:masterfrom
AlinsRan:fix/standalone-api-schema
Jul 18, 2025
Merged

fix(standalone): lack of configuration validation in api#12424
AlinsRan merged 13 commits into
apache:masterfrom
AlinsRan:fix/standalone-api-schema

Conversation

@AlinsRan

@AlinsRan AlinsRan commented Jul 14, 2025 •
edited
Loading

Copy link
Copy Markdown
Contributor

Description

Which issue(s) this PR fixes:

In standalone mode, the lack of code validation related to admin API results in incorrect configurations being able to pass validation, as shown in the following example:

  • Invalid plugin
  • route/service with invalid upstream
When configuring an invalid upstream:

Expect:

curl "http://127.0.0.1:9180/apisix/admin/configs" -H 'X-API-KEY: edd1c9f034335f136f87ad84b625c8f1' -X PUT -v -d '{
    "routes": [
        {
            "id": "r1",
            "uri": "/r2",
            "upstream": {
                "type": "chash",
                "nodes": {
                    "127.0.0.1:1980": 1
                },
                "hash_on": "vars",
                "key": "args_abc"
            }
        }
    ]
}'

< HTTP/1.1 400 Bad Request
< Server: APISIX/3.13.0
< 
{"error_msg":"invalid configuration: failed to match pattern \"^((uri|server_name|server_addr|request_uri|remote_port|remote_addr|query_string|host|hostname|mqtt_client_id)|arg_[0-9a-zA-z_-]+)$\" with \"args_abc\""}

Actual:

curl "http://127.0.0.1:9180/apisix/admin/configs" -H 'X-API-KEY: edd1c9f034335f136f87ad84b625c8f1' -X PUT -v -d '{
    "routes": [
        {
            "id": "r1",
            "uri": "/r2",
            "upstream": {
                "type": "chash",
                "nodes": {
                    "127.0.0.1:1980": 1
                },
                "hash_on": "vars",
                "key": "args_abc"
            }
        }
    ]
}'
> 
< HTTP/1.1 202 Accepted
< Server: APISIX/3.13.0
<
When configuring an invalid plugin

Expect:

curl "http://127.0.0.1:9180/apisix/admin/configs" -H 'X-API-KEY: edd1c9f034335f136f87ad84b625c8f1' -X PUT -d '{
    "routes": [
        {
            "id": "r1",
            "uri": "/r2",
            "upstream": {
                "type": "chash",
                "nodes": {
                    "127.0.0.1:1980": 1
                },
                "hash_on": "vars",
                "key": "args_abc"
            },
            "plugins": {
                "proxy-rewrite234": {
                    "uri": "/hello"
                }
            }
        }
    ]
}'
>
< HTTP/1.1 400 Bad Request
< Server: APISIX/3.13.0
< 
{"error_msg":"unknown plugin [proxy-rewrite234]"}

Actual:

 curl "http://127.0.0.1:9180/apisix/admin/configs" -H 'X-API-KEY: edd1c9f034335f136f87ad84b625c8f1' -v -X PUT -d '{
    "routes": [
        {
            "id": "r1",
            "uri": "/r2",
            "upstream": {
                "type": "chash",
                "nodes": {
                    "127.0.0.1:1980": 1
                },
                "hash_on": "vars",
                "key": "arg_abc"
            },
            "plugins": {
                "proxy-rewrite234": {
                    "uri": "/hello"
                }
            }
        }
    ]
}'
>
< HTTP/1.1 202 Accepted
< Server: APISIX/3.13.0
<

Checklist

  • I have explained the need for this PR and the problem it solves
  • I have explained the changes or the new features added to this PR
  • I have added tests corresponding to this change
  • I have updated the documentation to reflect this change
  • I have verified that this change is backward compatible (If not, please discuss on the APISIX mailing list first)

@dosubot dosubot Bot added size:L This PR changes 100-499 lines, ignoring generated files. bug Something isn't working labels Jul 14, 2025
nic-6443
nic-6443 reviewed Jul 14, 2025
View reviewed changes
Comment thread apisix/admin/consumers.lua Outdated
nic-6443
nic-6443 reviewed Jul 14, 2025
View reviewed changes
Comment thread apisix/admin/standalone.lua
nic-6443
nic-6443 reviewed Jul 14, 2025
View reviewed changes
Comment thread apisix/admin/consumers.lua Outdated
membphis
membphis previously approved these changes Jul 15, 2025
View reviewed changes

@membphis membphis left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

only one minor issue(about code style)

Comment thread apisix/admin/standalone.lua Outdated
@AlinsRan
AlinsRan requested a review from nic-6443 July 15, 2025 02:19
nic-6443
nic-6443 previously approved these changes Jul 15, 2025
View reviewed changes
bzp2010
bzp2010 requested changes Jul 15, 2025
View reviewed changes
Comment thread apisix/admin/consumer_group.lua Outdated
Comment thread apisix/admin/stream_routes.lua Outdated
@dosubot dosubot Bot added size:XL This PR changes 500-999 lines, ignoring generated files. and removed size:L This PR changes 100-499 lines, ignoring generated files. labels Jul 16, 2025
@AlinsRan
AlinsRan force-pushed the fix/standalone-api-schema branch from 358c5d8 to a2e22e8 Compare July 16, 2025 00:55
@dosubot dosubot Bot added size:L This PR changes 100-499 lines, ignoring generated files. and removed size:XL This PR changes 500-999 lines, ignoring generated files. labels Jul 16, 2025
@AlinsRan
AlinsRan requested a review from bzp2010 July 16, 2025 00:56
@AlinsRan
AlinsRan force-pushed the fix/standalone-api-schema branch from a2e22e8 to 340782f Compare July 16, 2025 01:06
bzp2010
bzp2010 reviewed Jul 16, 2025
View reviewed changes
Comment thread apisix/admin/consumers.lua
@AlinsRan
AlinsRan requested a review from bzp2010 July 16, 2025 05:23
bzp2010
bzp2010 reviewed Jul 16, 2025
View reviewed changes
Comment thread t/admin/standalone.spec.ts Outdated
@AlinsRan
AlinsRan requested a review from bzp2010 July 17, 2025 01:28
ronething
ronething approved these changes Jul 18, 2025
View reviewed changes

@ronething ronething left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

lgtm

@AlinsRan
AlinsRan merged commit c1dddde into apache:master Jul 18, 2025
34 of 38 checks passed
@AlinsRan
AlinsRan deleted the fix/standalone-api-schema branch July 18, 2025 06:31
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@bzp2010 bzp2010 bzp2010 approved these changes
@nic-6443 nic-6443 nic-6443 approved these changes
@ronething ronething ronething approved these changes
@membphis membphis membphis left review comments
@Baoyuantop Baoyuantop Awaiting requested review from Baoyuantop

Assignees

No one assigned

Labels

bug Something isn't working size:L This PR changes 100-499 lines, ignoring generated files.

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

5 participants

@AlinsRan @membphis @bzp2010 @nic-6443 @ronething