Doc: provide usage for APIResponse

mechanical-orchard · Oct 2, 2024 · 03b39c5 · 03b39c5
1 parent c7f5442
commit 03b39c5
Show file tree

Hide file tree

Showing 2 changed files with 9 additions and 0 deletions.
diff --git 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
@@ -113,6 +113,7 @@ defmodule Playwright.MixProject do
           Playwright,
           Playwright.APIRequest,
           Playwright.APIRequestContext,
+          Playwright.APIResponse,
           Playwright.Browser,
           Playwright.BrowserContext,
           Playwright.BrowserType,