hf400159 opened a new issue, #6912:
URL: https://github.com/apache/apisix/issues/6912
### Current State
In fact, in each plug-in of APISIX, there is a property table, such as the
following figure. But this has a problem, for example, the `Default` and `Valid
values` columns are mostly empty. So I suggest adding the contents of the
`Default` and `Valid values` columns to the `Description`. This makes the table
structure clearer. If there are many blank rows in the table, it is of no value
to the user.
Before changing:
| Name | type | Required |
Default | Valid values | Description
|
| ------------ | -------------------------------- | ----------- | -------- |
------------- | ---------------------------------------- |
| proto_id | string/integer | True |
| | id of the proto content. |
| service | string | True
| | | Name of the gRPC service.
|
| method | string | True
| | | Method name of the gRPC service. |
| deadline | number | False |
0 | | Deadline for the gRPC service in ms. |
| pb_option | array[string(pb_option_def)] | False |
| | protobuf options. |
After changing:
| Name | Type | Required |
Description
|
| ------------ | -------------------------------- | ----------- |
-------------------------------------------------------------- |
| proto_id | string/integer | True |
id of the proto content
|
| service | string | True
| Name of the gRPC service.
|
| method | string | True
| Method name of the gRPC service. |
| deadline | number | False |
Deadline for the gRPC service in ms. **Default value: 0.** |
| pb_option | array[string(pb_option_def)] | False | protobuf
options. |
### Desired State
Optimize the table structure in plugin documentation.
--
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: notifications-unsubscr...@apisix.apache.org.apache.org
For queries about this service, please contact Infrastructure at:
us...@infra.apache.org
