Skip to content

[2/n] [dropshot-api-manager] dedupe compatibility issues across APIs and versions#103

Merged
sunshowers merged 6 commits into
mainfrom
sunshowers/spr/2n-dropshot-api-manager-dedupe-compatibility-issues-across-apis-and-versions
May 20, 2026
Merged

[2/n] [dropshot-api-manager] dedupe compatibility issues across APIs and versions#103
sunshowers merged 6 commits into
mainfrom
sunshowers/spr/2n-dropshot-api-manager-dedupe-compatibility-issues-across-apis-and-versions

Conversation

@sunshowers
Copy link
Copy Markdown
Collaborator

@sunshowers sunshowers commented May 15, 2026

A lot of compat issues affect entire ranges of versions, and deduping them leads to a nicer user experience.

image

Created using spr 1.3.6-beta.1
Created using spr 1.3.6-beta.1

[skip ci]
Created using spr 1.3.6-beta.1
@sunshowers sunshowers requested a review from david-crespo May 15, 2026 19:49
error: OpenAPI document generated from the current code is not compatible
with the blessed document (from upstream)

backward-incompatible: A new, required parameter 'verbose' was added (see versioned-health v2.0.0)
Copy link
Copy Markdown
Contributor

@david-crespo david-crespo May 19, 2026

Choose a reason for hiding this comment

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

I worry about versioned-health v2.0.0 as a way of helping the user find the canonical description of the change. It doesn't look like it's even greppable in that form in the scrollback (scrollback says Failure versioned-health (versioned v2.0.0 (blessed)): Versioned Health API).

As with the list of affected endpoints, in an ideal world I almost want this to be inverted, whether rather than linearly going through the APIs, there is a summary view that shows the diff and lists the APIs affected by it. I understand that's more complex, so I can see why you'd punt on it, possibly forever. Just thinking through the current UX.

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

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

Yeah I see what you're saying -- ideally this would be indexed by API change first. Unfortunately that would need quite a bit more design work, so let's get this in for now.

Copy link
Copy Markdown
Contributor

@david-crespo david-crespo left a comment

Choose a reason for hiding this comment

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

I don't think my concern is a blocker, though you may want to try to ensure a more greppable identifier for the canonical description of the change in the scrollback.

Created using spr 1.3.6-beta.1

[skip ci]
Created using spr 1.3.6-beta.1
@sunshowers
Copy link
Copy Markdown
Collaborator Author

you may want to try to ensure a more greppable identifier for the canonical description of the change in the scrollback

I ended up switching to numeric anchors -- thanks for the feedback!

Created using spr 1.3.6-beta.1
@sunshowers sunshowers changed the base branch from sunshowers/spr/main.2n-dropshot-api-manager-dedupe-compatibility-issues-across-apis-and-versions to main May 20, 2026 04:05
@sunshowers sunshowers merged commit b2c77ea into main May 20, 2026
6 checks passed
@sunshowers sunshowers deleted the sunshowers/spr/2n-dropshot-api-manager-dedupe-compatibility-issues-across-apis-and-versions branch May 20, 2026 04:05
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants