Skip to content

Conversation

@pottekkat
Copy link
Member

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

Description

Updates the documentation of the "proxy-cache", "request-validatoin", "proxy-mirror", and "api-breaker" Plugins.

Child PR of #6734

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

// @hf400159 @kwanhur @avinal @yzeng25 @juzhiyuan Please review when you are available.

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

@juzhiyuan juzhiyuan left a comment

Choose a reason for hiding this comment

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

Others LGTM

Copy link
Contributor

@guitu168 guitu168 left a comment

Choose a reason for hiding this comment

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

other LGTM.

```shell
$ curl -i -X POST "http://127.0.0.1:9080/hello"
curl -i -X POST "http://127.0.0.1:9080/hello"
HTTP/1.1 502 Bad Gateway
Copy link
Contributor

Choose a reason for hiding this comment

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

The request and response should use two code blocks.

Response 500 or 503 three times in a row to trigger a unhealthy. Response 200 once in a row to restore healthy.
The example below shows how you can configure the Plugin on a specific Route:

```shell
Copy link
Contributor

Choose a reason for hiding this comment

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

This should be bash。please refer to #7030 (comment)

Copy link
Member Author

Choose a reason for hiding this comment

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

One thing is that shell also seems to work. It is what was used in the docs in the past and it was what I used in the previous PRs except for the last PR. I also did not see any support for it but it seems to work and we seem to be using it everywhere.

@juzhiyuan @hf400159 @avinal What do you think?

Copy link
Member

Choose a reason for hiding this comment

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

If the style guide doesn't mention which one should use, then both work for me :)

Copy link
Contributor

Choose a reason for hiding this comment

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

I agree with what you said

Copy link
Contributor

Choose a reason for hiding this comment

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

Either bash or shell is fine (though they have different meanings), when it comes to referring them in code block as bash and shell, they have the same behaviors.

I think you should consider specifying them in guidelines as well.

pottekkat added 3 commits May 15, 2022 19:04
Signed-off-by: Navendu Pottekkat <navendupottekkat@gmail.com>
Signed-off-by: Navendu Pottekkat <navendupottekkat@gmail.com>
Signed-off-by: Navendu Pottekkat <navendupottekkat@gmail.com>
@pottekkat
Copy link
Member Author

Made the changes as suggested.

Copy link
Member

@juzhiyuan juzhiyuan left a comment

Choose a reason for hiding this comment

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

LGTM

@spacewander spacewander merged commit 477d328 into apache:master May 16, 2022
@pottekkat pottekkat deleted the docs/plugin-traffic-2/6734 branch May 16, 2022 05:20
Liu-Junlin pushed a commit to Liu-Junlin/apisix that referenced this pull request May 20, 2022
Signed-off-by: Navendu Pottekkat <navendupottekkat@gmail.com>
spacewander pushed a commit that referenced this pull request Jun 30, 2022
Signed-off-by: Navendu Pottekkat <navendupottekkat@gmail.com>
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.

5 participants