Skip to content

Commit 931e5e3

Browse files
authored
Update wording on messageInRaw documentation (#1576)
Should be a bit more accessible.
2 parents cc8d266 + 4a7bd94 commit 931e5e3

File tree

8 files changed

+9
-9
lines changed

8 files changed

+9
-9
lines changed

csharp/Svix/Message.cs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ public Message(ISvixClient svixClient, IMessageApi messageApi)
2323
_messageApi = messageApi ?? throw new ArgumentException(nameof(messageApi));
2424
}
2525

26-
/// <summary>Creates a [MessageIn] with a pre-serialized payload.
26+
/// <summary>Creates a [MessageIn] with a raw string payload.
2727
/// <para>
2828
/// The payload is not normalized on the server. Normally, payloads are
2929
/// required to be JSON, and Svix will minify the payload before sending the

go/message.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -105,7 +105,7 @@ func (m *Message) ExpungeContent(ctx context.Context, appId string, msgId string
105105
return wrapError(err, res)
106106
}
107107

108-
// Instantiates a new MessageIn object with a pre-serialized payload.
108+
// Instantiates a new MessageIn object with a raw string payload.
109109
//
110110
// The payload is not normalized on the server. Normally, payloads are required
111111
// to be JSON, and Svix will minify the payload before sending the webhook

java/lib/src/main/java/com/svix/Message.java

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ private static MessageIn messageInEmptyPayload() {
2525
}
2626

2727
/**
28-
* Creates a MessageIn with a pre-serialized payload.
28+
* Creates a MessageIn with a raw string payload.
2929
*
3030
* The payload is not normalized on the server. Normally, payloads are
3131
* required to be JSON, and Svix will minify the payload before sending the
@@ -42,7 +42,7 @@ public static MessageIn messageInRaw(final String payload) {
4242
}
4343

4444
/**
45-
* Creates a MessageIn with a pre-serialized payload.
45+
* Creates a MessageIn with a raw string payload.
4646
*
4747
* This overload is intended for non-JSON payloads.
4848
*

javascript/src/api/message.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -64,7 +64,7 @@ export class Message {
6464
}
6565

6666
/**
67-
* Creates a `MessageIn` with a pre-serialized payload.
67+
* Creates a `MessageIn` with a raw string payload.
6868
*
6969
* The payload is not normalized on the server. Normally, payloads are
7070
* required to be JSON, and Svix will minify the payload before sending the

kotlin/lib/src/main/kotlin/Message.kt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -68,7 +68,7 @@ class Message internal constructor(token: String, options: SvixOptions) {
6868
}
6969

7070
/**
71-
* Creates a [MessageIn] with a pre-serialized payload.
71+
* Creates a [MessageIn] with a raw string payload.
7272
*
7373
* The payload is not normalized on the server. Normally, payloads are required to be JSON, and Svix
7474
* will minify the payload before sending the webhooks (for example, by removing extraneous

python/svix/api.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1166,7 +1166,7 @@ def message_in_raw(
11661166
event_type: str, payload: str, content_type: t.Optional[str] = None
11671167
) -> MessageIn:
11681168
"""
1169-
Creates a `MessageIn` with a pre-serialized payload.
1169+
Creates a `MessageIn` with a raw string payload.
11701170
11711171
The payload is not normalized on the server. Normally, payloads are required
11721172
to be JSON, and Svix will minify the payload before sending the webhook

ruby/lib/svix/message_api.rb

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ def expunge_content(app_id, msg_id)
2525
end
2626
end
2727

28-
# Creates a [`MessageIn`] with a pre-serialized payload.
28+
# Creates a [`MessageIn`] with a raw string payload.
2929
#
3030
# The payload is not normalized on the server. Normally, payloads are required
3131
# to be JSON, and Svix will minify the payload before sending the webhook

rust/src/model_ext.rs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ use crate::{
1010
};
1111

1212
impl MessageIn {
13-
/// Create a new message with a pre-serialized payload.
13+
/// Create a new message with a raw string payload.
1414
///
1515
/// The payload is not normalized on the server. Normally, payloads are
1616
/// required to be JSON, and Svix will minify the payload before sending

0 commit comments

Comments
 (0)