Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: update "Other protocols" Plugins #7312

Merged
merged 5 commits into from
Jun 30, 2022

Conversation

pottekkat
Copy link
Contributor

@pottekkat pottekkat commented Jun 23, 2022

Signed-off-by: Navendu Pottekkat navendupottekkat@gmail.com

Description

Updates the documentation of the "Other protocols" Plugins. Fixes #6734

Child PR of #6734

Signed-off-by: Navendu Pottekkat <navendupottekkat@gmail.com>
Signed-off-by: Navendu Pottekkat <navendupottekkat@gmail.com>
Copy link
Member

@membphis membphis left a comment

Choose a reason for hiding this comment

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

LGTM

Co-authored-by: 琚致远 <juzhiyuan@apache.org>
| method | string | optional | the path of uri | | dubbo provider service method|
| Name | Type | Required | Default | Description |
| --------------- | ------ | -------- | -------------------- | ------------------------------- |
| service_name | string | required | | Dubbo provider service name. |
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
| service_name | string | required | | Dubbo provider service name. |
| service_name | string | True | | Dubbo provider service name. |

| Name | Type | Required | Default | Description |
| --------------- | ------ | -------- | -------------------- | ------------------------------- |
| service_name | string | required | | Dubbo provider service name. |
| service_version | string | required | | Dubbo provider service version. |
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
| service_version | string | required | | Dubbo provider service version. |
| service_version | string | True | | Dubbo provider service version. |

| --------------- | ------ | -------- | -------------------- | ------------------------------- |
| service_name | string | required | | Dubbo provider service name. |
| service_version | string | required | | Dubbo provider service version. |
| method | string | optional | The path of the URI. | Dubbo provider service method. |
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
| method | string | optional | The path of the URI. | Dubbo provider service method. |
| method | string | False | The path of the URI. | Dubbo provider service method. |

| upstream_multiplex_count | number | required | 32 | >= 1 | the maximum number of multiplex requests in an upstream connection |
| Name | Type | Required | Default | Valid values | Description |
| ------------------------ | ------ | -------- | ------- | ------------ | --------------------------------------------------------------- |
| upstream_multiplex_count | number | required | 32 | >= 1 | Maximum number of multiplex requests in an upstream connection. |
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
| upstream_multiplex_count | number | required | 32 | >= 1 | Maximum number of multiplex requests in an upstream connection. |
| upstream_multiplex_count | number | True | 32 | >= 1 | Maximum number of multiplex requests in an upstream connection. |


## Requirement
If you are using OpenResty, you need to build it with Dubbo support. See [How do I build the APISIX base environment](./../FAQ.md#how-do-i-build-the-apisix-base-environment) for details.
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
If you are using OpenResty, you need to build it with Dubbo support. See [How do I build the APISIX base environment](./../FAQ.md#how-do-i-build-the-apisix-base-environment) for details.
If you are using OpenResty, you need to build it with Dubbo support. See [How do I build the APISIX base environment](./../FAQ.md#how-do-i-build-the-apisix-base-environment?) for details.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Signed-off-by: Navendu Pottekkat <navendupottekkat@gmail.com>
@pottekkat
Copy link
Contributor Author

Thank you @okaybase and @hf400159

I have made the changes as suggested.

@juzhiyuan juzhiyuan merged commit 7569eb9 into apache:master Jun 30, 2022
@pottekkat pottekkat deleted the docs/plugin-other/6734 branch June 30, 2022 08:18
Liu-Junlin pushed a commit to Liu-Junlin/apisix that referenced this pull request Nov 4, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

docs: Update plugin documentation
6 participants