plugin(hmac-auth): update the schema

[liuxiran]

Part of #2082

Current schema

{
	"additionalProperties": false,
	"properties": {
		"disable": {
			"type": "boolean"
		}
	},
	"title": "work with route or service object",
	"type": "object"
}

the plugin page looks:

---

Expected schema

according to the doc and test case

{
  "type": "object",
  "required": [
    "access_key",
    "secret_key"
  ],
  "properties": {
    "access_key": {
      "type": "string",
      "title": "Accesskey"
    },
    "secret_key": {
      "type": "string",
      "title": "Secretkey"
    },
    "algorithm": {
      "type": "string",
      "enum": [
        "hmac-sha1",
        "hmac-sha256",
        "hmac-sha512"
      ],
      "default": "hmac-sha256",
      "title": "Algorithm"
    },
    "clock_skew": {
      "type": "number",
      "title": "clockskew",
      "default": 0
    },
    "signed_headers": {
      "type": "array",
      "title": "A list of strings",
      "items": {
        "type": "string",
        "default": "bazinga"
      }
    }
  }
}

the form looks:

[liuxiran]

hmac-auth define two schemas:

• one is :

  apisix/apisix/plugins/hmac-auth.lua

  Line 40 in d1729c0

  local schema = {

• the other one is:

  apisix/apisix/plugins/hmac-auth.lua

  Line 47 in d1729c0

  local consumer_schema = {

• and the schema returned to the caller is only:

  apisix/apisix/plugins/hmac-auth.lua

  Line 80 in d1729c0

  schema = schema,

maybe this is the cause of the problem, and this case has already made part of the plugins unuseable in dashboard.

so is it possible to return differet schema depending on the different param or return all schemas that caller coulde Judge which one to use?

@juzhiyuan @moonming @membphis @spacewander

[juzhiyuan]

@membphis Please take a look

[spacewander]

I think we should pass the schema type to get the correct schema, since currently we already have three kinds of schema:

1. metadata
2. consumer
3. route/service

[membphis]

• metadata
• consumer

How about this API style?

/apisix/admin/schema/plugins/{plugin_name}/metadata
/apisix/admin/schema/plugins/{plugin_name}/consumer

[spacewander]

My suggestion is to put metadata/consumer into the arguments, if the argument is missing, choice the default plain schema.

[imjoey]

My suggestion is to put metadata/consumer into the arguments, if the argument is missing, choice the default plain schema.

+1 . IMHO, query parameters would be more flexible.

[membphis]

My suggestion is to put metadata/consumer into the arguments, if the argument is missing, choice the default plain schema.

this way is much better. agree +1

[liuxiran]

ok, based on the results of the discussion above, I think this issue contains at least two modifications:

• admin-api provides api like：

  • /apisix/admin/schema/plugins/{plugin_name} to get plugin schema
  • /apisix/admin/schema/plugins/{plugin_name}?schema_type=consumer_schema to get plugin consumer_schema

• dashboard calls the corresponding api to get the correct schema.

e.g:

1. consumer wants to config hmac-auth plugin, then call /apisix/admin/schema/plugins/hmac-auth?schema_type=consumer_schema to get the config schema

2. route wants to config hmac-auth plugin, then call /apisix/admin/schema/plugins/hmac-auth to get the config schema

my partner and I will take this issue :)

[juzhiyuan]

yep 😁

[membphis]

/apisix/admin/schema/plugins/{plugin_name}?schema_type=consumer_schema

to

/apisix/admin/schema/plugins/{plugin_name}?schema_type=consumer

simpler

[liuxiran]

/apisix/admin/schema/plugins/{plugin_name}?schema_type=consumer_schema

to

/apisix/admin/schema/plugins/{plugin_name}?schema_type=consumer

simpler

got it~!

[Jaycean]

Please assign to me