[2/n] [dropshot-api-manager] dedupe compatibility issues across APIs and versions#103
Conversation
Created using spr 1.3.6-beta.1
Created using spr 1.3.6-beta.1 [skip ci]
| 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) |
There was a problem hiding this comment.
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.
There was a problem hiding this comment.
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.
david-crespo
left a comment
There was a problem hiding this comment.
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
I ended up switching to numeric anchors -- thanks for the feedback! |
Created using spr 1.3.6-beta.1
A lot of compat issues affect entire ranges of versions, and deduping them leads to a nicer user experience.