From 6f77a0d73f2ef65f57a513b95f6af0184e83add5 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Filipe=20Caba=C3=A7o?= <filipe@supabase.io>
Date: Tue, 10 Oct 2023 00:48:02 +0100
Subject: [PATCH] fix: Improve docs on Broadcast endpoint (#697)

Adds the information that clients will prepend realtime: as their channel and users using this endpoint directly should also do that
---
 lib/realtime_web/open_api_schemas.ex | 6 +++++-
 mix.exs                              | 2 +-
 2 files changed, 6 insertions(+), 2 deletions(-)

diff --git a/lib/realtime_web/open_api_schemas.ex b/lib/realtime_web/open_api_schemas.ex
index 86a652c49..02eabee79 100644
--- a/lib/realtime_web/open_api_schemas.ex
+++ b/lib/realtime_web/open_api_schemas.ex
@@ -17,7 +17,11 @@ defmodule RealtimeWeb.OpenApiSchemas do
           items: %Schema{
             type: :object,
             properties: %{
-              topic: %Schema{type: :string},
+              topic: %Schema{
+                type: :string,
+                description:
+                  "Note: libraries will prepend the channel name with 'realtime:' so if you use this endpoint directly you'll need to also prepend 'realtime:' so it's captured by clients properly"
+              },
               payload: %Schema{type: :object},
               event: %Schema{type: :object}
             }
diff --git a/mix.exs b/mix.exs
index 20e233506..83f465889 100644
--- a/mix.exs
+++ b/mix.exs
@@ -4,7 +4,7 @@ defmodule Realtime.MixProject do
   def project do
     [
       app: :realtime,
-      version: "2.24.1",
+      version: "2.24.2",
       elixir: "~> 1.14.0",
       elixirc_paths: elixirc_paths(Mix.env()),
       start_permanent: Mix.env() == :prod,