navendu-pottekkat commented on code in PR #6911:
URL: https://github.com/apache/apisix/pull/6911#discussion_r856153415
##########
docs/en/latest/plugins/public-api.md:
##########
@@ -23,31 +29,28 @@ title: public-api
## Description
-The `public-api` plugin is used to enhance the plugin public API access
control.
-When current users develop custom plugins, they can register some public APIs
for fixed functionality, such as the `/apisix/plugin/jwt/sign` API in
`jwt-auth`. These APIs can only apply limited plugins for access control
(currently only `ip-restriction`) by way of plugin interceptors.
+The `public-api` is used for exposing an API endpoint through a general HTTP
API router.
-With the `public-api` plugin, we put all public APIs into the general HTTP API
router, which is consistent with the normal Route registered by the user and
can apply any plugin. The public API added in the user plugin is no longer
expose by default by APISIX, and the user has to manually configure the Route
for it, the user can configure any uri and plugin.
+When you are using custom Plugins, you can use the `public-api` Plugin to
define a fixed, public API for a particular functionality. For example, you can
create a public API endpoint `/apisix/plugin/jwt/sign` for JWT authentication
using the [jwt-auth](./jwt-auth.md) Plugin.
-## Attributes
-
-| Name | Type | Requirement | Default | Valid | Description |
-| -- | -- | -- | -- | -- | -- |
-| uri | string | optional | "" | | The uri of the public API. When you set
up the route, you can use this to configure the original API uri if it is used
in a way that is inconsistent with the original public API uri. |
+The public API added in a custom Plugin is not exposed by default and the user
should manually configure a Route and enable the `public-api` Plugin on it.
-## Example
+## Attributes
-We take the `jwt-auth` token sign API as an example to show how to configure
the `public-api` plugin. Also, the `key-auth` will be used to show how to
configure the protection plugin for the public API.
+| Name | Type | Required | Default | Description
|
Review Comment:
I thought the default value would be an empty string.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: [email protected]
For queries about this service, please contact Infrastructure at:
[email protected]
