Ewoks events schema versioning

[poautran]

In GitLab by @woutdenolf on Dec 29, 2025, 23:55 GMT+1:

I want to change the Ewoks events schema. But before I do that we should introduce versioning in a way that ewoksweb does not break when events are changed.

The projects involved: ewoksutils, ewoksserver and ewoksweb.

Assignees: @loichuder

Migrated from GitLab: https://gitlab.esrf.fr/workflow/ewoks/ewoksweb/-/issues/290

[poautran]

In GitLab by @loichuder on Jan 5, 2026, 13:29 GMT+1:

Is there a specific endpoint that will change ? Or is it a more generic request (i.e. encompassing all endpoints) ?

[poautran]

In GitLab by @woutdenolf on Jan 5, 2026, 13:43 GMT+1:

It is the Ewoks event schema that will change. What we do with endpoints is part of the discussion. Perhaps the current endpoint versioning is enough already to handle this from the server side.

[poautran]

In GitLab by @loichuder on Jan 5, 2026, 13:48 GMT+1:

If the endpoint will return a different event schema, then the ewoksserver API/endpoint version will need to be updated, yes.

Now, if we consider that ewoksweb needs to be compatible with only one ewoksserver API version (which we have done so far), then we can update ewoksweb to use the new API version and release a new ewoksweb version.

The old ewoksweb versions will still be there if someone for some reason, uses an older ewoksserver version.

Would that work?

[poautran]

In GitLab by @woutdenolf on Jan 5, 2026, 14:02 GMT+1:

Sure that would work.

As far as I understand ewoksweb pins the ewoksserver API major version:

https://gitlab.esrf.fr/workflow/ewoks/ewoksweb/-/blob/main/.env#L3

Not sure how this gets pip-installed actually ...

[poautran]

In GitLab by @loichuder on Jan 5, 2026, 14:34 GMT+1:

As far as I understand ewoksweb pins the ewoksserver API major version

By default, yes. I think this may be possible to override this with an env variable.

Not sure how this gets pip-installed actually ...

https://gitlab.esrf.fr/workflow/ewoks/ewoksweb/-/blob/9fb5c69f467c5c0f62b71019226b25536f906f98/pyproject.toml#L18

This ensures that the ewoksserver version always includes the api/v2 endpoint.

[poautran]

In GitLab by @woutdenolf on Jan 5, 2026, 17:50 GMT+1:

Ok so ewoksweb is accessing localhost:8000/api and not localhost:8000/api/vX.