0
Fork 0
mirror of https://github.com/ninenines/cowboy.git synced 2025-07-16 13:10:24 +00:00

Partially update manual for the cowboy_req

Only the access functions have been modified so far.
This commit is contained in:
Loïc Hoguin 2016-11-05 14:17:30 +02:00
parent 8fe700f341
commit faca7866ed
No known key found for this signature in database
GPG key ID: 71366FF21851DF03
16 changed files with 1409 additions and 895 deletions

View file

@ -0,0 +1,49 @@
= cowboy_req:version(3)
== Name
cowboy_req:version - HTTP version
== Description
[source,erlang]
----
version(Req :: cowboy_req:req()) -> Version :: cowboy:http_version()
----
Return the HTTP version used for the request.
The version can also be obtained using pattern matching:
[source,erlang]
----
#{version := Version} = Req.
----
== Arguments
Req::
The Req object.
== Return value
The HTTP version used for the request is returned as an
atom. It is provided for informative purposes only.
== Changelog
* *2.0*: Only the version is returned, it is no longer wrapped in a tuple.
* *1.0*: Function introduced.
== Examples
.Get the HTTP version
[source,erlang]
----
Version = cowboy_req:version(Req).
----
== See also
link:man:cowboy_req(3)[cowboy_req(3)]