From 03b39c5703fbd09303ce4618a86f9bd418567811 Mon Sep 17 00:00:00 2001
From: Corey Innis <corey@mechanical-orchard.com>
Date: Wed, 2 Oct 2024 16:58:40 -0400
Subject: [PATCH] Doc: provide usage for `APIResponse`

---
 lib/playwright/api_response.ex | 8 ++++++++
 mix.exs                        | 1 +
 2 files changed, 9 insertions(+)

diff --git a/lib/playwright/api_response.ex b/lib/playwright/api_response.ex
index 21a0775..a71de72 100644
--- a/lib/playwright/api_response.ex
+++ b/lib/playwright/api_response.ex
@@ -2,6 +2,14 @@ defmodule Playwright.APIResponse do
   @moduledoc """
   `Playwright.APIResponse` represents responses returned by
   `Playwrigh.APIRequestContext.fetch/3` and similar.
+
+  ## Usage
+
+      request = Playwright.request(session)
+      context = APIRequest.new_context(request)
+
+      response = APIRequest.get(context, "https://example.com")
+      json = APIResponse.json(response)
   """
 
   alias Playwright.APIRequestContext
diff --git a/mix.exs b/mix.exs
index aea78a9..bde17ae 100644
--- a/mix.exs
+++ b/mix.exs
@@ -113,6 +113,7 @@ defmodule Playwright.MixProject do
           Playwright,
           Playwright.APIRequest,
           Playwright.APIRequestContext,
+          Playwright.APIResponse,
           Playwright.Browser,
           Playwright.BrowserContext,
           Playwright.BrowserType,