Automate rest api version update

[stan-dot]

REST_API_VERSION = "0.0.5"

That is hard coded right now and last updated in Feb 2024, we'd likely want this to either be automatic or not there - and just use the pyproject version.

[callumforrester]

I think it is different to the pyproject version, in that breaking changes to the software and breaking changes to the version may be different. I wonder if there is a way to auto-detect breaking changes in an openapi schema...

[callumforrester]

A thought for how we could do this: We already have a test that detects whether the REST API has changed, it is intended as just a golden test.

We could have that test insist that the version is bumped when the API changes. It is left to the developer/reviewer to decide if it's a major/minor/patch change.

[callumforrester]

Probably need a test similar to this one that compares the version in the stored schema file to the version in the generated schema and gives the developer a nice error message explaining what to do and linking to https://semver.org/

Acceptance Criteria

• If I make code changes that change the openapi schema, a test tells me to update the version
• If I run blueapi schema -u (or some other means of updating the reference schema) and I have not updated the version, the test should still fail.