Remove completion_subscribers from Card shape#194
Closed
robzolkos wants to merge 1 commit intobasecamp:mainfrom
Closed
Remove completion_subscribers from Card shape#194robzolkos wants to merge 1 commit intobasecamp:mainfrom
robzolkos wants to merge 1 commit intobasecamp:mainfrom
Conversation
completion_subscribers is a todo-only feature. It was copy-pasted into the card API jbuilder template (6d68f56cc6, Nov 2022) when the CardTables JSON API was first created, carried over from the old kanban ticket template. The cards controller never accepted completion_subscriber_ids in wrap_parameters and has no write path for them, so the field always returns an empty array. The original addition of completion_subscribers to the public API (5ff5f73c00, Feb 2018) was explicitly for todos only. Removed from the Smithy spec, card fixtures, Go wrapper, and regenerated all language SDKs. Todos retain the field.
## Spec Change Impact
### Summary
The `completion_subscribers` field was removed from the `Card` shape.
### Impact
- **Removed Field**: `completion_subscribers` (from `Card` shape)
- **Breaking Change**: Yes (removal of a field constitutes a breaking API change)
### Required Actions
- All SDKs must be regenerated to reflect this change.
### Checklist of SDKs needing updates:
- [ ] Go
- [ ] TypeScript
- [ ] Ruby
- [ ] Kotlin
- [ ] Swift |
Review carefully before merging. Consider a major version bump. |
There was a problem hiding this comment.
Pull request overview
Removes completion_subscribers from the Card shape in the Smithy/OpenAPI specs and propagates that removal through regenerated SDK artifacts and fixtures (keeping the field on Todo, where it still applies).
Changes:
- Removed
completion_subscribersfrom the Card schema in Smithy and OpenAPI, plus TypeScript typings. - Updated generated SDK models to drop the corresponding Card field (Go, Ruby, Kotlin, Swift, TypeScript).
- Updated card JSON fixtures to no longer include
completion_subscribers.
Reviewed changes
Copilot reviewed 5 out of 13 changed files in this pull request and generated 1 comment.
Show a summary per file
| File | Description |
|---|---|
spec/basecamp.smithy |
Removes completion_subscribers from the Card structure. |
openapi.json |
Removes the Card schema property for completion_subscribers. |
typescript/src/generated/openapi-stripped.json |
Mirrors the OpenAPI change in the stripped artifact. |
typescript/src/generated/schema.d.ts |
Removes completion_subscribers from the Card TypeScript type. |
go/pkg/generated/client.gen.go |
Removes CompletionSubscribers from the generated Go Card model. |
go/pkg/basecamp/cards.go |
Removes CompletionSubscribers from the hand-wrapped Go Card model and its mapping from the generated type. |
ruby/lib/basecamp/generated/types.rb |
Removes Card’s completion_subscribers handling in Ruby generated types. |
swift/Sources/Basecamp/Generated/Models/Card.swift |
Removes completionSubscribers from the Swift Card model and initializer. |
kotlin/sdk/src/commonMain/kotlin/com/basecamp/sdk/generated/models/Card.kt |
Removes completionSubscribers from the Kotlin Card model. |
spec/fixtures/cards/list.json |
Removes completion_subscribers from card list fixture responses. |
spec/fixtures/cards/get.json |
Removes completion_subscribers from card get fixture response. |
typescript/src/generated/metadata.json |
Regeneration updates timestamp and adds ListLineupMarkers operation config. |
ruby/lib/basecamp/generated/metadata.json |
Regeneration updates timestamp and adds ListLineupMarkers operation config. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
You can also share your feedback on Copilot code review. Take the survey.
Collaborator
Author
|
Closing as keeping the result shape after all https://github.com/basecamp/bc3/pull/9967 |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
completion_subscribersfrom the Card shape in the Smithy specRelated PRs:
Summary by cubic
Removed
completion_subscribersfrom the Card shape in the Smithy spec, OpenAPI, and all SDKs. Cards never supported this field (it always returned an empty array); Todos still expose it.Card.completion_subscribersin your code.Todo.completion_subscribersif you need completion subscribers.Written for commit e2f72ad. Summary will update on new commits.