Skip to content

Commit 8c66eeb

Browse files
committed
improve xapi version doc
1 parent 7423271 commit 8c66eeb

1 file changed

Lines changed: 8 additions & 1 deletion

File tree

doc/xapi_version.md

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,13 @@
22

33
# xAPI Version Support
44

5-
As of v0.0.34 LRSPipe supports xAPI versions 1.0.3 and 2.0.0 using the `--source-xapi-version` and `--target-xapi-version` arguments. Note that when transferring statements from a 2.0.0 LRS to a 1.0.3 LRS statements will be downgraded to pass compatibility checks.
5+
As of v0.0.34 LRSPipe supports xAPI versions 1.0.3 and 2.0.0 using the `--source-xapi-version` and `--target-xapi-version` arguments. To pass validation checks LRSPipe must sometimes downgrade statement data to move it between LRS instances. Refer to the table below for more information:
6+
7+
| version | 1.0.3 target | 2.0.0 target |
8+
|--------------|-------------------------------|--------------|
9+
| 1.0.3 source | 2.0.0 data will be downgraded | no change |
10+
| 2.0.0 source | 2.0.0 data will be downgraded | no change |
11+
12+
Note that even when using version 1.0.3 for both source and target (the default) downgrading may occur if 2.0.0 data is present on the 1.0.3 LRS. To ensure 2.0.0 data like `$.context.contextAgents` is always preserved use the `--target-xapi-version 2.0.0` argument.
613

714
[<- Back to Index](index.md)

0 commit comments

Comments
 (0)