[versioning] add clear doc to inform customer risk to set api-version other than the latest one

Azure / autorest.typescript

Extension for AutoRest (https://github.com/Azure/autorest) that generates TypeScript code. The transpiled javascript code is isomorphic. It can be run in browser and in node.js environment.

MIT License

177 stars 73 forks source link

[versioning] add clear doc to inform customer risk to set api-version other than the latest one #2588

Open chunyu3 opened 2 weeks ago

chunyu3 commented 2 weeks ago

Add an api-version section in SDK readme as following:

refer to https://github.com/Azure/autorest.csharp/tree/feature/v3/test/TestProjects/sdk/newprojecttypespec/Azure.NewProject.TypeSpec#service-api-versions

If you have capability to send the customized http request, you can add separate section on the bottom to guide customer how to send the rest api if there are breaking changes and current SDK API is not valid for a special api-version.

qiaozha commented 2 weeks ago

Should we consider Modular glass breaker?