[2pt] 'interface' http.client option
Nobody has claimed this yet.
- Dominant language
- CSS
- Stars
- 15
- Forks
- 49
- Avg merge
- 1d 13h
- Merged PRs (30d)
- 3
Description
Product: Tarantool
Since: 2.10.0-beta2
Root document: a new interface request option (https://www.tarantool.io/en/doc/latest/reference/reference_lua/http/#request-options)
SME: @ norguhtar
Details
It allows setting source network interface for an outgoing
connection using the interface name or IP address.
For additional info see https://curl.haxx.se/libcurl/c/CURLOPT_INTERFACE.html
Requested by @norguhtar in https://github.com/tarantool/tarantool/commit/99272d7b02459f05638201a856e64d2c032efd2f
Example
Interface name (macOS):
http_client = require('http.client').new()
http_client:get('https://httpbin.org/get', {interface = 'en0'})
IP address:
http_client:get('https://httpbin.org/get', {interface = '172.18.112.36'})
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
Open the linked http.client request-options root document and inspect the surrounding option descriptions. Add the interface option, including its purpose and the name and IP-address examples from the issue. Done means the option is documented alongside the other request options and the rendered page is clear.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- lua
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Clearly specified
- Newbie friendliness
- 55/100