Repository navigation
Call GetMyNotifications' result notifications, not the Hey! menu - #988
Conversation
Codex Review SummaryThis comment shows the latest Codex review activity on this pull request.
ℹ️ About Codex in GitHubYour team has set up Codex to review pull requests in this repo. Reviews are triggered when you
Codex reacts with 👀 while any review is running, comments if it has suggestions, and reacts with 👍 once all reviews finish with no findings. |
github-actions
Bot
added
typescript
There was a problem hiding this comment.
🟢 Approved
The changes consistently update documentation and generation timestamps without altering wire behavior, types, or signatures.
0 open findings
What changed in this PR
Clarifies GetMyNotifications documentation across the SDK pipeline without changing API behavior.
Changes:
- Describes the result as notifications, identifying “Hey!” as the Basecamp 4 name.
- Propagates the wording through generated documentation and refreshes generation timestamps.
[!TIP]
If you aren't ready for review, convert to a draft PR.
Click "Convert to draft" or rungh pr ready --undo.
Click "Ready for review" or rungh pr readyto reengage.
| File | Description |
|---|---|
| typescript/src/generated/services/my-notifications.ts | Updates service documentation. |
| typescript/src/generated/schema.d.ts | Updates schema documentation. |
| typescript/src/generated/openapi-stripped.json | Updates operation description. |
| typescript/src/generated/metadata.ts | Refreshes generation timestamp. |
| spec/basecamp.smithy | Updates authoritative operation documentation. |
| rust/basecamp-sdk/src/generated/services/my_notifications.rs | Updates service documentation. |
| ruby/lib/basecamp/generated/types.rb | Refreshes timestamp comment. |
| ruby/lib/basecamp/generated/services/my_notifications_service.rb | Updates service documentation. |
| ruby/lib/basecamp/generated/metadata.json | Refreshes generation timestamp. |
| python/src/basecamp/generated/services/my_notifications.py | Updates synchronous and asynchronous docstrings. |
| openapi.json | Propagates Smithy description. |
| kotlin/sdk/src/commonMain/kotlin/com/basecamp/sdk/generated/services/my-notifications.kt | Updates service documentation. |
| go/pkg/basecamp/catalog/catalog.json | Updates catalog documentation. |
🧠 Review effort: Balanced
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
"Hey!" is the Basecamp 4 name for what Basecamp 5 shows in its notifications sidebar. The doc now says notifications and keeps "Hey!" as the Basecamp 4 alias, so a reader who knows the old name still finds it. Regenerated with make generate.
8b3c79d to
c02a4dc
Compare
|
@codex review |
|
Codex Review: Didn't find any major issues. Keep it up! Reviewed commit: ℹ️ About Codex in GitHubYour team has set up Codex to review pull requests in this repo. Reviews are triggered when you
If Codex has suggestions, it will comment; otherwise it will react with 👍. Codex can also answer questions or update the PR. Try commenting "@codex address that feedback". |
`GetMyNotifications` described its result as "the user's notification inbox (the "Hey!" menu)". Hey! is the Basecamp 4 name; Basecamp 5 shows notifications in the sidebar (`Pings + Notifications`, with `New for you` and `Previous notifications` sections).
Doc-only: no wire, type or signature change. Checked with `make smithy-check catalog-check go-check-drift ts-check-drift`.
Companion to basecamp/basecamp-mcp-server#229, which renames the MCP server's own text; that repo's tool descriptions come from its own definitions, not this doc.
Overlap
#991 (fix-pass-api-semantics) regenerates the same generated files (
ruby/lib/basecamp/generated/metadata.json,types.rb,typescript/src/generated/metadata.ts). Whichever of the two lands second resolves by rebasing onto the new main and rerunningmake generate.Summary by cubic
Updates the
GetMyNotificationsdocumentation to describe its result as notifications rather than as the "Hey!" menu, which is the Basecamp 4 name; Basecamp 5 shows notifications in the sidebar. The description now reads "Get the current user's notifications (the "Hey!" menu in Basecamp 4)" so readers who know the old name still find it. Regenerated the downstream SDKs from the Smithy spec; there is no wire, type, or signature change.Written for commit 8b3c79d. Summary will update on new commits.