[WIP] (api) Follow xAPI spec for versioning #452

Leobouloc · 2023-10-05T16:02:37Z

WIP

In link with : #424

Ralph currently does not follow the xAPI spec for versioning. It is proposed to implement:

The LRS MUST include the "X-Experience-API-Version" header in every response.
The LRS MUST set this header to the latest patch version.
Statements returned by an LRS MUST retain the version they are accepted with. If they lack a version, the version MUST be set to 1.0.0.

answer question: are the proposals above compatible (answer: https://github.com/adlnet/xAPI-Spec/blob/master/xAPI-Data.md#learning-record-provider-requirements-2)
add version to response header
test response headers for get, put, post
add version to statement (get)
test that version was properly added
parametrize version

wip. add version to response header

ed5e50b

Leobouloc added the WIP label Oct 5, 2023

Leobouloc changed the title ~~(api) Follow xAPI spec for versionning~~ [WIP] (api) Follow xAPI spec for versioning Oct 5, 2023

Leobouloc added 2 commits October 10, 2023 11:48

add version to statements retrieved by GET + test

7fd84d1

parametrize xAPI versions

248f8dc

wilbrdt assigned Leobouloc Oct 19, 2023

wilbrdt linked an issue Oct 19, 2023 that may be closed by this pull request

Return version with all statement #424

Open

wilbrdt added this to the 5.0 milestone Oct 19, 2023