Immich Crosslink

Test links

For version 1.0

The test links are the protocol’s examples with their answers, for implementations to test against. They live in tests/links.json, a file meant to be read by tests. Fetch it at the commit or tag of the version you implement.

What the file holds

Some read links carry parameters this version does not define. A receiver MUST ignore them and still reach show: they are there so every implementation ignores unknown parameters from the start, rather than only in theory.

Using it

curl -LO https://raw.githubusercontent.com/jakobhviid/immich-crosslink/main/tests/links.json

For each make entry, build the link from item, server and user and compare it with link. For each read entry, read link and compare the result, and for show the kind, path, server and user.

A change to the protocol adds the test links that show it, in the same pull request. A bug found in an implementation, where the protocol was unclear, adds the link that would have caught it.