Skip to content

Commit

Permalink
Update wording on messageInRaw documentation (#1576)
Browse files Browse the repository at this point in the history
Should be a bit more accessible.
  • Loading branch information
svix-jplatte authored Dec 18, 2024
2 parents cc8d266 + 4a7bd94 commit 931e5e3
Show file tree
Hide file tree
Showing 8 changed files with 9 additions and 9 deletions.
2 changes: 1 addition & 1 deletion csharp/Svix/Message.cs
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ public Message(ISvixClient svixClient, IMessageApi messageApi)
_messageApi = messageApi ?? throw new ArgumentException(nameof(messageApi));
}

/// <summary>Creates a [MessageIn] with a pre-serialized payload.
/// <summary>Creates a [MessageIn] with a raw string payload.
/// <para>
/// The payload is not normalized on the server. Normally, payloads are
/// required to be JSON, and Svix will minify the payload before sending the
Expand Down
2 changes: 1 addition & 1 deletion go/message.go
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
4 changes: 2 additions & 2 deletions java/lib/src/main/java/com/svix/Message.java
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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.
*
Expand Down
2 changes: 1 addition & 1 deletion javascript/src/api/message.ts
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion kotlin/lib/src/main/kotlin/Message.kt
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion python/svix/api.py
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion ruby/lib/svix/message_api.rb
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion rust/src/model_ext.rs
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down

0 comments on commit 931e5e3

Please sign in to comment.