From 4a7bd9499cd598f4acff7faca5973fbed0f0d5c1 Mon Sep 17 00:00:00 2001 From: Jonas Platte Date: Wed, 18 Dec 2024 16:56:03 +0100 Subject: [PATCH] Update wording on messageInRaw documentation --- csharp/Svix/Message.cs | 2 +- go/message.go | 2 +- java/lib/src/main/java/com/svix/Message.java | 4 ++-- javascript/src/api/message.ts | 2 +- kotlin/lib/src/main/kotlin/Message.kt | 2 +- python/svix/api.py | 2 +- ruby/lib/svix/message_api.rb | 2 +- rust/src/model_ext.rs | 2 +- 8 files changed, 9 insertions(+), 9 deletions(-) diff --git a/csharp/Svix/Message.cs b/csharp/Svix/Message.cs index 9a0a36e8e..75a6c67cf 100644 --- a/csharp/Svix/Message.cs +++ b/csharp/Svix/Message.cs @@ -23,7 +23,7 @@ public Message(ISvixClient svixClient, IMessageApi messageApi) _messageApi = messageApi ?? throw new ArgumentException(nameof(messageApi)); } - /// Creates a [MessageIn] with a pre-serialized payload. + /// Creates a [MessageIn] with a raw string payload. /// /// The payload is not normalized on the server. Normally, payloads are /// required to be JSON, and Svix will minify the payload before sending the diff --git a/go/message.go b/go/message.go index f8d8f1d1e..fe7c5b2d5 100644 --- a/go/message.go +++ b/go/message.go @@ -105,7 +105,7 @@ func (m *Message) ExpungeContent(ctx context.Context, appId string, msgId string return wrapError(err, res) } -// Instantiates a new MessageIn object with a pre-serialized payload. +// Instantiates a new MessageIn object with a raw string payload. // // The payload is not normalized on the server. Normally, payloads are required // to be JSON, and Svix will minify the payload before sending the webhook diff --git a/java/lib/src/main/java/com/svix/Message.java b/java/lib/src/main/java/com/svix/Message.java index 8338b0ce4..72343d4c7 100644 --- a/java/lib/src/main/java/com/svix/Message.java +++ b/java/lib/src/main/java/com/svix/Message.java @@ -25,7 +25,7 @@ private static MessageIn messageInEmptyPayload() { } /** - * Creates a MessageIn with a pre-serialized payload. + * Creates a MessageIn with a raw string payload. * * The payload is not normalized on the server. Normally, payloads are * required to be JSON, and Svix will minify the payload before sending the @@ -42,7 +42,7 @@ public static MessageIn messageInRaw(final String payload) { } /** - * Creates a MessageIn with a pre-serialized payload. + * Creates a MessageIn with a raw string payload. * * This overload is intended for non-JSON payloads. * diff --git a/javascript/src/api/message.ts b/javascript/src/api/message.ts index 58c62d6bc..6c6383b3d 100644 --- a/javascript/src/api/message.ts +++ b/javascript/src/api/message.ts @@ -64,7 +64,7 @@ export class Message { } /** - * Creates a `MessageIn` with a pre-serialized payload. + * Creates a `MessageIn` with a raw string payload. * * The payload is not normalized on the server. Normally, payloads are * required to be JSON, and Svix will minify the payload before sending the diff --git a/kotlin/lib/src/main/kotlin/Message.kt b/kotlin/lib/src/main/kotlin/Message.kt index f0b115727..9500bddb8 100644 --- a/kotlin/lib/src/main/kotlin/Message.kt +++ b/kotlin/lib/src/main/kotlin/Message.kt @@ -68,7 +68,7 @@ class Message internal constructor(token: String, options: SvixOptions) { } /** - * Creates a [MessageIn] with a pre-serialized payload. + * Creates a [MessageIn] with a raw string payload. * * The payload is not normalized on the server. Normally, payloads are required to be JSON, and Svix * will minify the payload before sending the webhooks (for example, by removing extraneous diff --git a/python/svix/api.py b/python/svix/api.py index 53c01f3ea..85f384975 100644 --- a/python/svix/api.py +++ b/python/svix/api.py @@ -1166,7 +1166,7 @@ def message_in_raw( event_type: str, payload: str, content_type: t.Optional[str] = None ) -> MessageIn: """ - Creates a `MessageIn` with a pre-serialized payload. + Creates a `MessageIn` with a raw string payload. The payload is not normalized on the server. Normally, payloads are required to be JSON, and Svix will minify the payload before sending the webhook diff --git a/ruby/lib/svix/message_api.rb b/ruby/lib/svix/message_api.rb index 10aecfee4..313e0e3f2 100644 --- a/ruby/lib/svix/message_api.rb +++ b/ruby/lib/svix/message_api.rb @@ -25,7 +25,7 @@ def expunge_content(app_id, msg_id) end end - # Creates a [`MessageIn`] with a pre-serialized payload. + # Creates a [`MessageIn`] with a raw string payload. # # The payload is not normalized on the server. Normally, payloads are required # to be JSON, and Svix will minify the payload before sending the webhook diff --git a/rust/src/model_ext.rs b/rust/src/model_ext.rs index b5e934637..9a42afc75 100644 --- a/rust/src/model_ext.rs +++ b/rust/src/model_ext.rs @@ -10,7 +10,7 @@ use crate::{ }; impl MessageIn { - /// Create a new message with a pre-serialized payload. + /// Create a new message with a raw string payload. /// /// The payload is not normalized on the server. Normally, payloads are /// required to be JSON, and Svix will minify the payload before sending