tarantool / tarantool/doc

`http_version` option for a set of functions in

Open
#4,128 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

3.1 http reference
Dominant language
CSS
Stars
15
Forks
49
Avg merge
1d 13h
Merged PRs (30d)
3

Description

Related dev. issue(s): https://github.com/tarantool/tarantool/issues/9806

Product: Tarantool
Since: 3.1
Root document: https://www.tarantool.io/en/doc/latest/reference/reference_lua/http/
SME: @ Col-Waltz

Details

http.client module.

The http_version option allows to set version of http in functions like
request(), post(), get() and etc using this curl option:
https://curl.se/libcurl/c/CURLOPT_HTTP_VERSION.html
The http_version takes one of the strings listed below or a nil value
and sets the appropriate protocol version.

List of supported values:

  1. nil - works as '2-tls' by default.
  2. '1.1' - sets HTTP/1.1 version.
  3. '2' - sets HTTP/2 version that falls back to HTTP/1.1 if cannot be
    negotiated with the server.
  4. '2-tls' - works as '2' for HTTPS and as '1.1' for plain text HTTP.
  5. '2-prior-knowledge' sets HTTP/2 version without HTTP/1.1 at back.
    It requires prior knowledge that the server supports HTTP/2.
    Requested by @ Col-Waltz in https://github.com/tarantool/tarantool/commit/c3695de1468f860229e04002786c1da11d76ce08.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with the linked HTTP client reference document and locate the entries for request(), post(), get(), and related functions. Document the http_version option, its accepted values, defaults, and HTTP/HTTPS behavior; the work is done when the reference accurately covers the listed protocol versions.

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
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.