Conversation
…er_schedule_count These three fields were defined in the Smithy spec and test fixture but the Basecamp API never returns them. The BC3 app doesn't compute them and they're absent from the API docs. The SDK deserialized them as zero values (0), which was misleading — e.g. completed_count showed 0 even when a project had fully-completed todolists. Removed from the Smithy spec, fixture, hand-written Go wrapper/tests, and regenerated all language SDKs (Go, TypeScript, Ruby, Kotlin, Swift).
github-actions
bot
added
typescript
## Spec Change Impact
### Summary
- **Removed Fields**: Phantom fields from `Todoset` have been removed.
### Impact
- **Breaking Change**: Yes, this is a breaking change as it removes fields from `Todoset`.
- **SDKs Requiring Regeneration**: All SDKs will need regeneration to reflect this change.
### Checklist for SDK Updates:
- [ ] Go
- [ ] TypeScript
- [ ] Ruby
- [ ] Kotlin
- [ ] Swift
Please ensure all SDKs are updated accordingly, as this change will affect any existing code depending on the removed fields. |
There was a problem hiding this comment.
Pull request overview
This PR removes three previously exposed Todoset fields (completed_count, on_schedule_count, over_schedule_count) across the spec, fixtures, and all generated SDKs because the Basecamp API does not populate them (they were always misleading zeros).
Changes:
- Removed the three phantom fields from the Smithy spec and OpenAPI outputs.
- Updated fixtures and regenerated/updated all SDK models (Go, TypeScript, Ruby, Swift, Kotlin) to drop the fields.
- Updated Go wrapper conversion and tests to align with the new
Todosetshape.
Tip
If you aren't ready for review, convert to a draft PR.
Click "Convert to draft" or run gh pr ready --undo.
Click "Ready for review" or run gh pr ready to reengage.
Reviewed changes
Copilot reviewed 5 out of 13 changed files in this pull request and generated no comments.
Show a summary per file
| File | Description |
|---|---|
| spec/basecamp.smithy | Removes the three fields from the source spec for Todoset. |
| openapi.json | Removes the three properties from the canonical OpenAPI schema. |
| spec/fixtures/todosets/get.json | Removes the fields from the Todoset fixture payload. |
| go/pkg/generated/client.gen.go | Regenerated Go client model with the fields removed. |
| go/pkg/basecamp/todosets.go | Removes fields from the hand-written Todoset wrapper + mapping from generated type. |
| go/pkg/basecamp/todosets_test.go | Updates tests to stop asserting removed fields. |
| typescript/src/generated/openapi-stripped.json | Removes the three properties from the stripped OpenAPI used by TS generation. |
| typescript/src/generated/schema.d.ts | Removes the three fields from the TS Todoset type surface. |
| typescript/src/generated/metadata.json | Updates generation metadata for the TS artifacts. |
| ruby/lib/basecamp/generated/types.rb | Removes accessors/parsing/serialization of the three fields in Ruby Todoset. |
| ruby/lib/basecamp/generated/metadata.json | Updates generation metadata for the Ruby artifacts. |
| swift/Sources/Basecamp/Generated/Models/Todoset.swift | Removes the three properties and initializer parameters from Swift Todoset. |
| kotlin/sdk/src/commonMain/kotlin/com/basecamp/sdk/generated/models/Todoset.kt | Removes the three properties from Kotlin Todoset. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
![cubic-dev-ai[bot]](https://avatars.githubusercontent.com/in/1082092?s=60&v=4){kind=small}
![chatgpt-codex-connector[bot]](https://avatars.githubusercontent.com/in/1144995?s=60&v=4){kind=small}
There was a problem hiding this comment.
💡 Codex Review
Here are some automated review suggestions for this pull request.
Reviewed commit: 591ef7a47b
ℹ️ About Codex in GitHub
Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you
- Open a pull request for review
- Mark a draft as ready
- Comment "@codex review".
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".
| todolists_url: String | ||
| completed_ratio: String | ||
| completed: Boolean | ||
| completed_count: Integer | ||
| on_schedule_count: Integer | ||
| over_schedule_count: Integer | ||
| app_todolists_url: String |
There was a problem hiding this comment.
Because this change is explicitly syncing the Todoset shape to match upstream BC3/API behavior, AGENTS.md requires a matching spec/api-provenance.json update and make provenance-sync. Leaving provenance untouched means the repo still records the old bc3-api/bc3 SHAs as the conformance baseline, so make sync-status and later audits will compare future diffs against the wrong upstream revision.
Useful? React with 👍 / 👎.
|
Duplicate of #193 — opened by mistake on the wrong branch. |
There was a problem hiding this comment.
Pull request overview
Removes three “phantom” count fields from the Todoset model across the spec, fixtures, OpenAPI, and all generated SDKs so the SDKs no longer surface misleading zero values for fields the Basecamp API never returns.
Changes:
- Removed
completed_count,on_schedule_count, andover_schedule_countfrom the Smithy spec, OpenAPI artifacts, and fixture. - Regenerated/updated
Todosettypes across Go, TypeScript, Ruby, Swift, and Kotlin to match the updated schema. - Updated Go wrapper + tests to reflect the slimmer
Todosetshape.
Tip
If you aren't ready for review, convert to a draft PR.
Click "Convert to draft" or run gh pr ready --undo.
Click "Ready for review" or run gh pr ready to reengage.
Reviewed changes
Copilot reviewed 5 out of 13 changed files in this pull request and generated no comments.
Show a summary per file
| File | Description |
|---|---|
spec/basecamp.smithy |
Removes the three count fields from the source model definition. |
openapi.json |
Removes the three properties from the canonical OpenAPI schema. |
spec/fixtures/todosets/get.json |
Removes the phantom fields from the Todoset fixture payload. |
go/pkg/generated/client.gen.go |
Drops the three fields from the generated Go Todoset model. |
go/pkg/basecamp/todosets.go |
Removes the three fields from the handwritten Go wrapper model + mapping. |
go/pkg/basecamp/todosets_test.go |
Removes assertions that depended on the phantom fixture fields. |
typescript/src/generated/openapi-stripped.json |
Keeps the stripped OpenAPI in sync (properties removed). |
typescript/src/generated/schema.d.ts |
Drops the three fields from the generated TypeScript type surface. |
typescript/src/generated/metadata.json |
Regeneration timestamp update. |
ruby/lib/basecamp/generated/types.rb |
Removes accessors/parsing/serialization for the three fields. |
ruby/lib/basecamp/generated/metadata.json |
Regeneration timestamp update. |
swift/Sources/Basecamp/Generated/Models/Todoset.swift |
Removes the three properties from the generated Swift model + initializer. |
kotlin/sdk/src/commonMain/kotlin/com/basecamp/sdk/generated/models/Todoset.kt |
Removes the three properties from the generated Kotlin data class. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
There was a problem hiding this comment.
Pull request overview
Removes three Todoset “count” fields (completed_count, on_schedule_count, over_schedule_count) that the Basecamp API never populates, eliminating misleading always-zero values across the spec, fixtures, and all generated SDKs (plus the handwritten Go wrapper/tests).
Changes:
- Removed the three fields from Smithy, OpenAPI (full + stripped), and the todoset fixture.
- Regenerated/updated Todoset models in TypeScript, Ruby, Swift, Kotlin, and Go generated client.
- Updated the Go handwritten Todoset wrapper + unmarshalling test to match the new shape.
Tip
If you aren't ready for review, convert to a draft PR.
Click "Convert to draft" or run gh pr ready --undo.
Click "Ready for review" or run gh pr ready to reengage.
Reviewed changes
Copilot reviewed 5 out of 13 changed files in this pull request and generated no comments.
Show a summary per file
| File | Description |
|---|---|
| typescript/src/generated/schema.d.ts | Drops the three phantom count properties from the TS Todoset type surface. |
| typescript/src/generated/openapi-stripped.json | Removes the count properties from the stripped OpenAPI schema used by TS generation. |
| typescript/src/generated/metadata.json | Refreshes generation timestamp for TS artifacts. |
| swift/Sources/Basecamp/Generated/Models/Todoset.swift | Removes the three count fields from the Swift Todoset model + initializer. |
| spec/fixtures/todosets/get.json | Deletes count fields from the canonical todoset fixture response. |
| spec/basecamp.smithy | Removes the three members from the Smithy Todoset structure (source of truth). |
| ruby/lib/basecamp/generated/types.rb | Removes accessors/serialization for the three fields from Ruby Todoset type. |
| ruby/lib/basecamp/generated/metadata.json | Refreshes generation timestamp for Ruby artifacts. |
| openapi.json | Removes the three count properties from the full OpenAPI spec output. |
| kotlin/sdk/src/commonMain/kotlin/com/basecamp/sdk/generated/models/Todoset.kt | Removes the three count properties from the Kotlin Todoset data class. |
| go/pkg/generated/client.gen.go | Removes the three fields from the generated Go Todoset model. |
| go/pkg/basecamp/todosets_test.go | Removes assertions for fields that no longer exist in Todoset unmarshalling. |
| go/pkg/basecamp/todosets.go | Removes fields from handwritten Go Todoset and updates conversion from generated model. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Summary
completed_count,on_schedule_count, andover_schedule_countfrom theTodosetmodel across all SDKs (Go, TypeScript, Ruby, Swift, Kotlin)Breaking change
This removes three public fields from the
Todosettype in all five SDKs. At v0.6.0 this is easier to justify, but it still deserves explicit breaking-change labeling. Any consumer referencing these fields will get a compile/type error on upgrade — though such code was already working against values that were always zero.Affected surfaces:
Todosetstruct ingo/pkg/basecamp/todosets.goTodosettype intypescript/src/generated/schema.d.tsTodosetclass inruby/lib/basecamp/generated/types.rbTodosetstruct inswift/Sources/Basecamp/Generated/Models/Todoset.swiftTodosetdata class inkotlin/sdk/src/commonMain/kotlin/com/basecamp/sdk/generated/models/Todoset.ktChanges
Surgical removal through all layers: Smithy spec → OpenAPI → fixture → all 5 SDKs + hand-written Go wrapper + tests.
Test plan
Summary by cubic
Remove three phantom fields from the
Todosetmodel across all SDKs to match the Basecamp API and remove misleading zero values. This is a breaking change removingcompleted_count,on_schedule_count, andover_schedule_countfrom generated types and the Go wrapper.Refactors
Migration
completedandcompleted_ratio, or compute counts via todolists/todos endpoints if needed.Written for commit 591ef7a. Summary will update on new commits.