What is a change workflow?

[goldbergyoni]

First, kudos for the great project!

Question - Say I already created a typespec and generated all the associated code. Then I'm tasked with adding a new field to some route. What is the workflow:

• Should I add the field in the code or in the typespec? What if my code type changed since I generated it for the first time?
• What should the client (e.g., frontend) do now?

Thanks

[qballer]

The main challenge with designing APIs is handling breaking changes. If you add a new required field to a route, the client code will break upon publishing a new version to the server. Sometimes, client and server code are within the same repo, so you can get away with it. At other times, the API is a product your company provides to its users, and those client libraries might take a long time to update.
In this case, you have a couple of options:

Create a new endpoint where the new field is required
Add an optional field to your existing endpoint

In both cases, the workflow should first update the TypeSpec file and then generate the server and/or client code. Both options are non-breaking, so it depends on the context of your problem. I can provide more targeted advice if you could give me more details about your specific example.