anil.recoil.org / ocaml-requests
A batteries included HTTP/1.1 client in OCaml
fork atom
ocaml-requests / spec /
at claude-test 15 files
README.md
rfc1950.txt
rfc1951.txt
rfc2818.txt
rfc3986.txt
rfc6265.txt
rfc6750.txt
rfc7235.txt
rfc7616.txt
rfc7617.txt
rfc8446.txt
rfc9110.txt
rfc9111.txt
rfc9112.txt
rfc9113.txt
README.md

RFC Specifications#

This directory contains IETF RFC specifications relevant to the OCaml Requests HTTP client library implementation.

Core HTTP Specifications#

RFC 9110 - HTTP Semantics#

{{:https://datatracker.ietf.org/doc/html/rfc9110}RFC 9110}

Defines the core HTTP semantics, including methods, status codes, header fields, content negotiation, authentication framework, and caching. This is the foundational specification for all HTTP versions.

Status: Internet Standard (June 2022) Obsoletes: RFC 7230, 7231, 7232, 7233, 7235, 7538, 7615, 7694

RFC 9112 - HTTP/1.1#

{{:https://datatracker.ietf.org/doc/html/rfc9112}RFC 9112}

Specifies HTTP/1.1 message syntax, connection management, and framing. Essential for implementing HTTP/1.1 clients.

Status: Internet Standard (June 2022) Obsoletes: RFC 7230

RFC 9113 - HTTP/2#

{{:https://datatracker.ietf.org/doc/html/rfc9113}RFC 9113}

Defines the HTTP/2 protocol, including binary framing, multiplexing, stream prioritization, and server push.

Status: Internet Standard (June 2022) Obsoletes: RFC 7540, 8740

URI and Resource Identification#

RFC 3986 - URI Generic Syntax#

{{:https://datatracker.ietf.org/doc/html/rfc3986}RFC 3986}

Defines the generic syntax for Uniform Resource Identifiers (URIs), including parsing, resolution, and normalization rules.

Status: Internet Standard (January 2005) Obsoletes: RFC 2732, 2396, 1808

Authentication#

RFC 7235 - HTTP Authentication Framework#

{{:https://datatracker.ietf.org/doc/html/rfc7235}RFC 7235}

Defines the HTTP authentication framework, including challenge-response mechanism and the WWW-Authenticate and Authorization header fields.

Status: Proposed Standard (June 2014)

RFC 7617 - HTTP Basic Authentication#

{{:https://datatracker.ietf.org/doc/html/rfc7617}RFC 7617}

Specifies the "Basic" HTTP authentication scheme, using base64-encoded username:password credentials.

Status: Proposed Standard (September 2015) Obsoletes: RFC 2617

RFC 6750 - OAuth 2.0 Bearer Token Usage#

{{:https://datatracker.ietf.org/doc/html/rfc6750}RFC 6750}

Defines how to use bearer tokens in HTTP requests to access OAuth 2.0 protected resources.

Status: Proposed Standard (October 2012)

State Management#

RFC 6265 - HTTP State Management Mechanism (Cookies)#

{{:https://datatracker.ietf.org/doc/html/rfc6265}RFC 6265}

Specifies the HTTP cookie mechanism for maintaining state between client and server, including Set-Cookie and Cookie header fields.

Status: Proposed Standard (April 2011) Obsoletes: RFC 2965

Security#

RFC 2818 - HTTP Over TLS#

{{:https://datatracker.ietf.org/doc/html/rfc2818}RFC 2818}

Defines how HTTP is secured using TLS (Transport Layer Security), including the https URI scheme and certificate verification.

Status: Informational (May 2000)

RFC 8446 - The Transport Layer Security (TLS) Protocol Version 1.3#

{{:https://datatracker.ietf.org/doc/html/rfc8446}RFC 8446}

Specifies TLS 1.3, the latest version of the Transport Layer Security protocol used to secure HTTP connections.

Status: Proposed Standard (August 2018) Obsoletes: RFC 5077, 5246

Using These Specifications#

When implementing features or fixing bugs in the OCaml Requests library, refer to the relevant RFC sections and include citations in the code documentation using the OCamldoc link format:

(** [get uri] performs an HTTP GET request.

    Implements {{:https://datatracker.ietf.org/doc/html/rfc9110#section-9.3.1}RFC 9110 Section 9.3.1}
    for the GET method semantics. *)

Additional Resources#