Clarify buffer_http option - Githubissues

openfaas / of-watchdog

Reverse proxy for STDIO and HTTP microservices

MIT License

259 stars 115 forks source link

Clarify buffer_http option #81

Closed alexellis closed 4 years ago

alexellis commented 4 years ago

Signed-off-by: Alex Ellis (OpenFaaS Ltd) alexellis2@gmail.com

Description

Clarify the buffer_http option

Motivation and Context

A user was confused by what "buffer_http" meant and assumed it meant the response, but the README describes it as being about the request input.

How Has This Been Tested?

This patch was tested with unit tests and makes the value more descriptive to avoid future confusion.

Types of changes

[ ] Bug fix (non-breaking change which fixes an issue)
[x] New feature (non-breaking change which adds functionality)
[ ] Breaking change (fix or feature that would cause existing functionality to change)

Checklist:

[x] My code follows the code style of this project.
[x] My change requires a change to the documentation.
[x] I have updated the documentation accordingly.
[x] I've read the CONTRIBUTION guide
[x] I have signed-off my commits with git commit -s
[x] I have added tests to cover my changes.
[x] All new and existing tests passed.