`http.client` documentation: document that using `params` together with `body` results in an error.
Open
Beginner friendly
Nobody has claimed this yet.
- Dominant language
- CSS
- Stars
- 15
- Forks
- 49
- Avg merge
- 1d 13h
- Merged PRs (30d)
- 3
Description
Page:
https://www.tarantool.io/en/doc/latest/reference/reference_lua/http/#body
https://www.tarantool.io/en/doc/latest/reference/reference_lua/http/#query-parameters
Document that using post(uri, body, {params}) results in an error. Either body or params are supported. Not both at once.
Otherwise an error is returned:
c:post('https://httpbin.org/anything', {
user_id = 123,
user_name = 'John Smith'
},
{params = {
param1 = 1,
param2 = 'asdf'
}})
---
- error: 'builtin/http.client.lua:573: use either body or http params'
...
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with the body and query-parameters sections of the Tarantool HTTP client documentation linked in the issue. Document that post(uri, body, {params = ...}) is invalid because body and params cannot be used together, and include the resulting error behavior shown in the issue.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- lua
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 1/5
- Estimated time
- Under an hour
- Activity status
- Quiet
- Clarity
- Clearly specified
- Newbie friendliness
- 88/100