Thanks - I think this is good

[q] Was the old implementation part of an official release?

Looks like it's part of the schema in 2024-11-05

LMK if this means I should hold off on merging btw, will wait to hear 😁

As long as it's backwards compatible on the wire, that's the key thing. SDKs can always provide their own backward compatibility for typed interfaces.

Small nitpick: I wouldn't generally refer to these as "classes," as they're just descriptions of JSON that gets sent on the wire.

As long as it's backwards compatible on the wire, that's the key thing. SDKs can always provide their own backward compatibility for typed interfaces.

Couple questions re syncing schema changes to the SDKs we maintain:

• the Python SDK should continue to work as-is since it doesn't change the wire format, but we'll want to update the classes soonish. Are there other dependencies/ripple effects beyond the immediate SDK codebase we need to coordinate?
• if the TS SDK uses these definitions here, does that mean code in the SDK will break until we update it?

Small nitpick: I wouldn't generally refer to these as "classes," as they're just descriptions of JSON that gets sent on the wire.

Ah yep missed the edit (only in the description right?)

This doesn't change anything on the wire, so it shouldn't break any SDK immediately. When we incorporate the typing changes, we might want to make sure the (e.g.) Python and JS changes are backwards compatible, but I don't expect that will be difficult. Easiest way would be to just bring this change in and see what breaks.

This doesn't change anything on the wire, so it shouldn't break any SDK immediately. When we incorporate the typing changes, we might want to make sure the (e.g.) Python and JS changes are backwards compatible, but I don't expect that will be difficult. Easiest way would be to just bring this change in and see what breaks.

Makes sense. FWIW I looked around to see what the coupling was between the spec schema and the SDKs, recording observations here for posterity/reality check:

• it looks like the Python SDK already declares the annotations property inline (example, so the change in this PR actually moves the schema closer to the way types are laid out there
• if I'm reading it right, the TS sdk doesn't declare annotations properties at all? example

Anyway, merging.