Apisix-dashboard: improve some minor issues

[juzhiyuan]

Here are some minor issues on the Login page we could resolve.

TODO

• [ ] Left icon replacement. @LiteSun
• [ ] Extracting Table as a separate component for reuse in various modules.
• [ ] APISIX plugin type change.
• [ ] GitHub hyperlink (icon) added to Header section.

[iamayushdas]

Would like to work on this Assign this to me @juzhiyuan

[juzhiyuan]

as for the first one, @LiteSun will do that.

[iamayushdas]

Here are some minor issues on the Login page we could resolve.

TODO

• [ ] Left icon replacement. @LiteSun
• [ ] Extracting Table as a separate component for reuse in various modules.
• [ ] APISIX plugin type change.
• [ ] GitHub hyperlink (icon) added to Header section.

could please brief 3rd todo?

[juzhiyuan]

oh yes, we have 40+ plugins here[1], and take basic-auth[2] as an example, you could see it's belonged to auth type[3].

We have other plugins that without type filed or just use the default type field, like this one[4], we need to update them. You could find all type here[5]:

Please use lowercase as type.

[1] https://github.com/apache/apisix/tree/master/apisix/plugins
[2] https://github.com/apache/apisix/blob/master/apisix/plugins/basic-auth.lua
[3] https://github.com/apache/apisix/blob/master/apisix/plugins/basic-auth.lua#L53
[4] https://github.com/apache/apisix/blob/master/apisix/plugins/kafka-logger.lua#L60
[5] http://apisix.apache.org/docs/apisix/plugins/batch-requests

[iamayushdas]

Here
[5] http://apisix.apache.org/docs/apisix/plugins/batch-requests
i am not able to find type for plugin that i have to put in local _M={}
can you please tell me more on what type will be used in transformation plugins.,i am lil confused

@juzhiyuan

[spacewander]

@juzhiyuan
Your description of the type field is wrong!
It is nothing about the category in the documentation.

The auth type in the APISIX has a special meaning (although this name is quite confusing) - to mark a plugin should be interacted with the consumer.

I have explained the same thing many times:
https://github.com/apache/apisix-dashboard/issues/1174#issuecomment-754508964
https://github.com/apache/apisix-dashboard/issues/1387#issuecomment-772592212

[juzhiyuan]

😳 then how do add a category for every plugin? I have read through some plugins' codes and only see the type field here.

https://github.com/apache/apisix/blob/master/apisix/plugins/basic-auth.lua#L53

[iamayushdas]

😳 then how do add a category for every plugin? I have read through some plugins' codes and only see the type field here.

https://github.com/apache/apisix/blob/master/apisix/plugins/basic-auth.lua#L53

Exactly this is confusing for me too

[spacewander]

It is all about the doc.
There is no formal standard to determine which category a plugin will belong to yet.

[juzhiyuan]

all right, just to be more clear, what type filed does? 🤔 I couldn't find its description.

[1] https://apisix.apache.org/docs/apisix/architecture-design/plugin

[spacewander]

See https://github.com/apache/apisix/blob/master/docs/en/latest/plugin-develop.md#schema-and-check

[juzhiyuan]

Thanks!

After read through this description about how to write a plugin, When we set the type of plugin to auth, it means that this plugin is an authentication plugin. does this mean the type field is only used with Auth plugins now? could we set type = security to a plugin?

[spacewander]

does this mean the type field is only used with Auth plugins now?

Yes.

could we set type = security to a plugin

Why? This is meaningless.

[spacewander]

The type and the category are two different things.
If you want to mark a plugin with a category, better to introduce a new field called "category".

[juzhiyuan]

🤔 not sure ... if type is Only used with Auth plugin, why not use is_auth_plugin to replace type = auth?

[spacewander]

does this mean the type field is only used with Auth plugins now

To be correct, it is plugins need to work with consumers, not plugins used to authenticate.
A plugin used to authenticate can be used with or without a consumer.

[juzhiyuan]

all right, @iamayushdas Hi, this issue may get pending due to we have something need to discuss. 🤔 Please take other issues 🐱

[iamayushdas]

@juzhiyuan in 4th task you mean to add a github icon next to the language change icon?

[juzhiyuan]

ya

[juzhiyuan]

and link it to https://apisix.apache.org

[iamayushdas]

## TODO

• [ ] Left icon replacement. @LiteSun
• [ ] Extracting Table as a separate component for reuse in various modules.
• [ ] APISIX plugin type change.
• [x] GitHub hyperlink (icon) added to Header section.

PR: #1650

[juzhiyuan]

good good