tarantool / tarantool/http

Add `req:read_cached()` to readme

Open
#175 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

documentation
Dominant language
Lua
Stars
81
Forks
41
PR merge metrics
No merged PRs in 30d

Description

I needed to extract the body of the query as a string without parsing json.
I expected req:request_line() to return the query body because of it's description "returns the request body". But in my case it returned "GET /tokens/1? HTTP/1.1".
Please, change description of req:request_line() and add req:read_cached() to readme.

Contributor guide

No contributing guide indexed for this repository

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

Open the README and locate the entries for req:request_line() and req:read_cached(). Clarify that req:request_line() returns the HTTP request line, document req:read_cached() for reading the cached query body without JSON parsing, and verify both entries match the API behavior.

Written by the indexing model from the issue text.

Assessment

Tech stack
lua
Domain
documentation
Issue type
Documentation
Difficulty
1/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Clearly specified
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.