Skip to content

docs(api): group the topic digest endpoints under Digests, and match the docs voice #165

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
mikemilla merged 1 commit into from
Sep 15, 2026
Merged

docs(api): group the topic digest endpoints under Digests, and match the docs voice #165

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions ...c/main/kotlin/com/courier/models/users/preferences/PreferenceUpdateOrCreateTopicParams.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -506,7 +506,7 @@ private constructor(

/**
* Put this recipient on one of the topic's digest schedules. Send `null` to clear the
* choice and return them to the topic's default. Omit to leave an existing choice alone --
* choice and return them to the topic's default. Omit to leave an existing choice alone,
* unlike the routing fields, which this endpoint replaces. An id that is not an active
* schedule on the topic is rejected with a `400` before anything is written.
*
Expand Down Expand Up @@ -657,8 +657,8 @@ private constructor(

/**
* Put this recipient on one of the topic's digest schedules. Send `null` to clear the
* choice and return them to the topic's default. Omit to leave an existing choice alone
* -- unlike the routing fields, which this endpoint replaces. An id that is not an
* choice and return them to the topic's default. Omit to leave an existing choice
* alone, unlike the routing fields, which this endpoint replaces. An id that is not an
* active schedule on the topic is rejected with a `400` before anything is written.
*/
fun digestScheduleId(digestScheduleId: String?) =
Expand Down
12 changes: 6 additions & 6 deletions courier-java-core/src/main/kotlin/com/courier/models/users/preferences/TopicPreference.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -117,9 +117,9 @@ private constructor(
customRouting.getOptional("custom_routing")

/**
* The digest schedule this recipient is on for the topic. Omitted -- not null -- when they have
* not chosen one, in which case the topic's default schedule applies. Ids come from the topic's
* digest configuration or from `GET /digests/schedules`.
* The digest schedule this recipient is on for the topic. Omitted rather than null when they
* have not chosen one, in which case the topic's default schedule applies. Ids come from the
* topic's digest configuration or from `GET /digests/schedules`.
*
* @throws CourierInvalidDataException if the JSON field has an unexpected type (e.g. if the
* server responded with an unexpected value).
Expand Down Expand Up @@ -378,9 +378,9 @@ private constructor(
}

/**
* The digest schedule this recipient is on for the topic. Omitted -- not null -- when they
* have not chosen one, in which case the topic's default schedule applies. Ids come from
* the topic's digest configuration or from `GET /digests/schedules`.
* The digest schedule this recipient is on for the topic. Omitted rather than null when
* they have not chosen one, in which case the topic's default schedule applies. Ids come
* from the topic's digest configuration or from `GET /digests/schedules`.
*/
fun digestScheduleId(digestScheduleId: String) =
digestScheduleId(JsonField.of(digestScheduleId))
Expand Down
2 changes: 1 addition & 1 deletion ...r-java-core/src/main/kotlin/com/courier/models/workspacepreferences/TopicDigestRequest.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ import kotlin.jvm.optionals.getOrNull
* how collected events are retained.
*
* Send `null` for the whole object to turn a digest off, which unlinks the template and removes its
* schedules. There is no `enabled` flag, and `schedules: []` is rejected -- both states are
* schedules. There is no `enabled` flag, and `schedules: []` is rejected, because both states are
* un-deliverable rather than merely off.
*/
class TopicDigestRequest
Expand Down
8 changes: 4 additions & 4 deletions ...n/kotlin/com/courier/models/workspacepreferences/WorkspacePreferenceTopicCreateRequest.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -110,8 +110,8 @@ private constructor(
* and how collected events are retained.
*
* Send `null` for the whole object to turn a digest off, which unlinks the template and removes
* its schedules. There is no `enabled` flag, and `schedules: []` is rejected -- both states are
* un-deliverable rather than merely off.
* its schedules. There is no `enabled` flag, and `schedules: []` is rejected, because both
* states are un-deliverable rather than merely off.
*
* @throws CourierInvalidDataException if the JSON field has an unexpected type (e.g. if the
* server responded with an unexpected value).
Expand Down Expand Up @@ -350,8 +350,8 @@ private constructor(
* on, and how collected events are retained.
*
* Send `null` for the whole object to turn a digest off, which unlinks the template and
* removes its schedules. There is no `enabled` flag, and `schedules: []` is rejected --
* both states are un-deliverable rather than merely off.
* removes its schedules. There is no `enabled` flag, and `schedules: []` is rejected,
* because both states are un-deliverable rather than merely off.
*/
fun digest(digest: TopicDigestRequest?) = digest(JsonField.ofNullable(digest))

Expand Down
8 changes: 4 additions & 4 deletions .../kotlin/com/courier/models/workspacepreferences/WorkspacePreferenceTopicReplaceRequest.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -113,8 +113,8 @@ private constructor(
* and how collected events are retained.
*
* Send `null` for the whole object to turn a digest off, which unlinks the template and removes
* its schedules. There is no `enabled` flag, and `schedules: []` is rejected -- both states are
* un-deliverable rather than merely off.
* its schedules. There is no `enabled` flag, and `schedules: []` is rejected, because both
* states are un-deliverable rather than merely off.
*
* @throws CourierInvalidDataException if the JSON field has an unexpected type (e.g. if the
* server responded with an unexpected value).
Expand Down Expand Up @@ -352,8 +352,8 @@ private constructor(
* on, and how collected events are retained.
*
* Send `null` for the whole object to turn a digest off, which unlinks the template and
* removes its schedules. There is no `enabled` flag, and `schedules: []` is rejected --
* both states are un-deliverable rather than merely off.
* removes its schedules. There is no `enabled` flag, and `schedules: []` is rejected,
* because both states are un-deliverable rather than merely off.
*/
fun digest(digest: TopicDigestRequest?) = digest(JsonField.ofNullable(digest))

Expand Down
Loading