From d39c2e3de27bc9cb6fa1da63bc0e34be0f3fe07f Mon Sep 17 00:00:00 2001
From: Gabriel Ciuloaica <con_gabriel.ciuloaica@dream11.com>
Date: Fri, 14 Jan 2022 17:03:04 +0200
Subject: [PATCH] re-organized the section. added more examples on the service,
 client and middleware side.

---
 docs/website/docs/dsl/headers/index.md | 100 +++++++++++++++++++++++--
 1 file changed, 95 insertions(+), 5 deletions(-)

diff --git a/docs/website/docs/dsl/headers/index.md b/docs/website/docs/dsl/headers/index.md
index 5875a4ba1c..b18394b395 100644
--- a/docs/website/docs/dsl/headers/index.md
+++ b/docs/website/docs/dsl/headers/index.md
@@ -1,12 +1,102 @@
-# Headers
+# Headers API
 
-Headers API provides a ton of powerful operators that can be used to add, remove and modify headers.
+Headers API provides a ton of powerful operators that can be used to add, remove and modify headers. 
+Same Headers API could be used on both client, server and middleware.
 
-`Headers`      - represents an immutable collection of headers i.e. essentially a `Chunk[(String, String)]`.
+`zhttp.http.Headers`      - represents an immutable collection of headers i.e. essentially a `Chunk[(String, String)]`.
 
-`HeaderNames`  - commonly use header names.
+`zhttp.http.HeaderNames`  - commonly used header names.
 
-`HeaderValues` - commonly use header values
+`zhttp.http.HeaderValues` - commonly used header values
+
+## Client API
+
+The following example shows how you can add headers on the client request and how to check presence of header in client response.
+```scala
+import zhttp.http.{HeaderNames, HeaderValues, Headers}
+import zhttp.service.{ChannelFactory, Client, EventLoopGroup}
+import zio.{App, ExitCode, URIO, console}
+
+object SimpleClientJson extends App {
+  val env     = ChannelFactory.auto ++ EventLoopGroup.auto()
+  val url     = "http://sports.api.decathlon.com/groups/water-aerobics"
+  // Construct headers
+  val headers = Headers.host("sports.api.decathlon.com").withAccept(HeaderValues.applicationJson) 
+
+  val program = for {
+    // Pass headers to request
+    res  <- Client.request(url, headers)
+    // List all response headers
+    _    <- console.putStrLn(res.headers.toList.mkString("\n"))
+    data <-
+      // Check if response contains a specified header with a specified value.
+      if (res.hasHeader(HeaderNames.contentType, HeaderValues.applicationJson))
+        res.getBodyAsString
+      else
+        res.getBodyAsString
+    _    <- console.putStrLn { data }
+  } yield ()
+
+  override def run(args: List[String]): URIO[zio.ZEnv, ExitCode] = program.exitCode.provideCustomLayer(env)
+
+}
+```
+
+## Server API
+
+The following example shows how to use Headers API on the server side. 
+
+```scala
+import zhttp.http._
+import zhttp.service.Server
+import zio.{App, Chunk, ExitCode, URIO}
+import zio.stream.ZStream
+
+object SimpleResponseDispatcher extends App {
+  override def run(args: List[String]): URIO[zio.ZEnv, ExitCode] = {
+
+    // Starting the server (for more advanced startup configuration checkout `HelloWorldAdvanced`)
+    Server.start(8090, app.silent).exitCode
+  }
+
+  // Create a message as a Chunk[Byte]
+  val message                    = Chunk.fromArray("Hello world !\r\n".getBytes(HTTP_CHARSET))
+  // Use `Http.collect` to match on route
+  val app: HttpApp[Any, Nothing] = Http.collect[Request] {
+
+    // Simple (non-stream) based route
+    case Method.GET -> !! / "health" => Response.ok
+
+    // From Request(req), the headers are accessible.
+    case req @ Method.GET -> !! / "streamOrNot" =>
+      // Checking if client is able to handle streaming response
+      val acceptsStreaming: Boolean = req.hasHeader(HeaderNames.accept, HeaderValues.applicationOctetStream)
+      if (acceptsStreaming)
+        Response(
+          status = Status.OK,
+          // Setting response header
+          headers = Headers.contentLength(message.length.toLong),
+          data = HttpData.fromStream(ZStream.fromChunk(message)), // Encoding content using a ZStream
+        )
+      else Response(status = Status.ACCEPTED, data = HttpData.fromChunk(message))
+  }
+}
+
+```
+
+## Middleware API
+
+Middleware Service allows access of both Request and Response headers. It provides:
+
+`zhttp.http.Middleware.addHeader` - to add a custom header in response (for example, in case of basic authentication when you have to provide the  `WWW_AUTHENTICATE` header in case the authentication fail.)
+
+`zhttp.http.Middleware.addHeaders` - to add one or more headers in response.
+
+Example: 
+- [BasicAuth](https://github.com/dream11/zio-http/blob/main/example/src/main/scala/BasicAuth.scala)
+- [Authentication](https://github.com/dream11/zio-http/blob/main/example/src/main/scala/Authentication.scala)
+
+## More examples
 
 - Constructors: