Skip to content

Record dock tool create contract change in api-gaps registry#389

Merged
jeremy merged 1 commit into
mainfrom
api-gap/dock-tool-create-contract
Jul 22, 2026
Merged

Record dock tool create contract change in api-gaps registry#389
jeremy merged 1 commit into
mainfrom
api-gap/dock-tool-create-contract

Conversation

@jeremy

@jeremy jeremy commented Jul 22, 2026

Copy link
Copy Markdown
Member

Registers the BC4→BC5 dock tool creation contract change (clone → create-by-type) in the api-gaps registry, following the memories-emptied-regression precedent for live contract regressions, and records it as the third cross-team contract decision in COORDINATION.md.

Summary

  • New entry spec/api-gaps/dock-tool-create-contract.md: four required source_recording_id on POST /buckets/{bucket_id}/dock/tools.json; BC5 (master) creates by tool_type and 404s the documented clone shape (surfaced live as tools create returns a 404 instead of creating a new tool in the project basecamp-cli#471).
  • Compatibility posture is settled by release — BC5 replaced BC4 in production, so there is no live BC4 backend to shim. four survives as the wire-format reference (compatibility.bc3-four) for BC4-era clients; the live-world impact is BC4-era clients on the documented clone contract failing against production.
  • The precise gap record: a hybrid wire body (source_recording_id + tool_type + title) is structurally accepted by both contract snapshots, but the SDK CreateTool signature (Update dock tool creation to current bucket-scoped API #327) cannot emit it; the route exists on both (resource :dock { resources :tools } under resources :buckets on four and master), so the divergence is body-level only.
  • COORDINATION.md §Contract decisions gains item 3 (settled by release; doc tail bc3#12364).
  • Status is absorbed-in-sdk with smithy_refs: [CreateTool]Update dock tool creation to current bucket-scoped API #327 merged 2026-07-22. The only remaining tail is the upstream doc rewrite (bc3#12364).

Context in basecamp/basecamp-cli#471.

Verification

  • make validate-api-gaps — clean (16 entries + allowlist).

Copilot AI review requested due to automatic review settings July 22, 2026 07:10
@github-actions github-actions Bot added the spec Changes to the Smithy spec or OpenAPI label Jul 22, 2026
@github-actions

github-actions Bot commented Jul 22, 2026

Copy link
Copy Markdown

Spec Change Impact

  • Operations Added: None

  • Operations Modified: DockToolCreateContract

  • Operations Removed: None

  • Types/Resources Added: None

  • Types/Resources Modified: None

  • Types/Resources Removed: None

  • SDKs Needing Regeneration: All

  • Breaking Change: No

Checklist of SDKs needing updates:

  • Go
  • TypeScript
  • Ruby
  • Kotlin
  • Swift

@github-actions github-actions Bot added the bug Something isn't working label Jul 22, 2026

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Registers the BC4→BC5 dock tool creation contract flip (clone-by-source_recording_id → create-by-tool_type) in the spec/api-gaps/ registry so the cross-version incompatibility is tracked through the “detect → address → absorb” lifecycle.

Changes:

  • Added a new api-gap entry documenting the BC4 vs BC5 request-body divergence for POST /:account_id/buckets/:bucket_id/dock/tools.json.
  • Updated the api-gaps registry index to include the new entry as partial-coverage.

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 2 out of 2 changed files in this pull request and generated no comments.

File Description
spec/api-gaps/README.md Adds the new gap to the registry table with partial-coverage status.
spec/api-gaps/dock-tool-create-contract.md New gap entry documenting the BC4↔BC5 dock tool create contract change and SDK compatibility implications.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

@chatgpt-codex-connector chatgpt-codex-connector Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

💡 Codex Review

Here are some automated review suggestions for this pull request.

Reviewed commit: 53abf5f416

ℹ️ 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".

Comment thread spec/api-gaps/dock-tool-create-contract.md

@cubic-dev-ai cubic-dev-ai Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

All reported issues were addressed across 2 files

Reply with feedback, questions, or to request a fix.

Re-trigger cubic

Comment thread spec/api-gaps/dock-tool-create-contract.md Outdated
Copilot AI review requested due to automatic review settings July 22, 2026 08:17
@jeremy
jeremy force-pushed the api-gap/dock-tool-create-contract branch from 53abf5f to d521627 Compare July 22, 2026 08:17
@github-actions github-actions Bot added documentation Improvements or additions to documentation and removed bug Something isn't working labels Jul 22, 2026

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Copilot reviewed 2 out of 2 changed files in this pull request and generated 1 comment.

Comment thread spec/api-gaps/dock-tool-create-contract.md
Copilot AI review requested due to automatic review settings July 22, 2026 08:30
@jeremy
jeremy force-pushed the api-gap/dock-tool-create-contract branch from d521627 to d5509c0 Compare July 22, 2026 08:30
@github-actions github-actions Bot added documentation Improvements or additions to documentation and removed documentation Improvements or additions to documentation labels Jul 22, 2026

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Copilot reviewed 2 out of 2 changed files in this pull request and generated no new comments.

Copilot AI review requested due to automatic review settings July 22, 2026 08:32
@jeremy
jeremy force-pushed the api-gap/dock-tool-create-contract branch from d5509c0 to ccaafd6 Compare July 22, 2026 08:32
@github-actions github-actions Bot removed the documentation Improvements or additions to documentation label Jul 22, 2026

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Copilot reviewed 2 out of 2 changed files in this pull request and generated no new comments.

@chatgpt-codex-connector chatgpt-codex-connector Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

💡 Codex Review

Here are some automated review suggestions for this pull request.

Reviewed commit: ccaafd65af

ℹ️ 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".

Comment thread spec/api-gaps/dock-tool-create-contract.md Outdated
Copilot AI review requested due to automatic review settings July 22, 2026 08:39
@jeremy
jeremy force-pushed the api-gap/dock-tool-create-contract branch from ccaafd6 to 07799e1 Compare July 22, 2026 08:39
@github-actions github-actions Bot added the documentation Improvements or additions to documentation label Jul 22, 2026

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Copilot reviewed 3 out of 3 changed files in this pull request and generated no new comments.

@chatgpt-codex-connector chatgpt-codex-connector Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

💡 Codex Review

Here are some automated review suggestions for this pull request.

Reviewed commit: 07799e109e

ℹ️ 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".

Comment thread spec/api-gaps/dock-tool-create-contract.md Outdated
Copilot AI review requested due to automatic review settings July 22, 2026 08:46
@jeremy
jeremy force-pushed the api-gap/dock-tool-create-contract branch from 07799e1 to 1d1dd7d Compare July 22, 2026 08:46

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Copilot reviewed 3 out of 3 changed files in this pull request and generated 1 comment.

Comment thread spec/api-gaps/dock-tool-create-contract.md Outdated
Copilot AI review requested due to automatic review settings July 22, 2026 08:51
@jeremy
jeremy force-pushed the api-gap/dock-tool-create-contract branch from 1d1dd7d to 2e57f96 Compare July 22, 2026 08:51

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Copilot reviewed 3 out of 3 changed files in this pull request and generated 1 comment.

Comment thread spec/api-gaps/dock-tool-create-contract.md
@jeremy
jeremy force-pushed the api-gap/dock-tool-create-contract branch from 2e57f96 to 0287fc3 Compare July 22, 2026 08:56
@jeremy
jeremy requested a review from Copilot July 22, 2026 08:56
@github-actions github-actions Bot added enhancement New feature or request and removed documentation Improvements or additions to documentation labels Jul 22, 2026
@jeremy
jeremy merged commit f55a6b5 into main Jul 22, 2026
44 checks passed
@jeremy
jeremy deleted the api-gap/dock-tool-create-contract branch July 22, 2026 08:57

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Copilot reviewed 3 out of 3 changed files in this pull request and generated no new comments.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

enhancement New feature or request spec Changes to the Smithy spec or OpenAPI

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants