Skip to content

Commit

Permalink
fix: Improve docs on Broadcast endpoint (#697)
Browse files Browse the repository at this point in the history
Adds the information that clients will prepend realtime: as their channel and users using this endpoint directly should also do that
  • Loading branch information
filipecabaco authored Oct 9, 2023
1 parent a26de31 commit 6f77a0d
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 2 deletions.
6 changes: 5 additions & 1 deletion lib/realtime_web/open_api_schemas.ex
Original file line number Diff line number Diff line change
Expand Up @@ -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}
}
Expand Down
2 changes: 1 addition & 1 deletion mix.exs
Original file line number Diff line number Diff line change
Expand Up @@ -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,
Expand Down

0 comments on commit 6f77a0d

Please sign in to comment.