core icon indicating copy to clipboard operation
core copied to clipboard

Considering change to the openapi schema as a BC break.

Open joelwurtz opened this issue 4 months ago • 0 comments

Not really a feature, but more about the process of releasing new versions of api platform

When we upgrade api platform to new minor/patch versions like the last one (4.2.1 -> 4.2.2) we may have a lot of works in order to be able to use it.

In fact, we are using the openapi schema definition to generate javascript client, however change like this PR : https://github.com/api-platform/core/pull/7397 or this one : https://github.com/api-platform/core/pull/7398 update the name of definitions or others change that induce a new client being generated (new definition name by example) with new name / type and so it break the js app behind that.

Then a minor/patch upgrade can induce a lot of work on our side to be able to support it.

  • Does our approach (generating a client from generated openapi from api platform) is wrong ?
  • If not, should those changes be considered BC break and their should be a way to detect them ? (Like reproduce this process and checking that the typescript is OK ? i may be able to do a PR for that if you want)

joelwurtz avatar Oct 20 '25 15:10 joelwurtz