aboutsummaryrefslogtreecommitdiffstats
path: root/tests/files/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'tests/files/README.md')
-rw-r--r--tests/files/README.md26
1 files changed, 26 insertions, 0 deletions
diff --git a/tests/files/README.md b/tests/files/README.md
new file mode 100644
index 000000000..0f7dbe5a6
--- /dev/null
+++ b/tests/files/README.md
@@ -0,0 +1,26 @@
+tests
+=====
+
+Common tests for all clients to test against.
+
+All files should be of the form:
+
+```
+{
+ "test1name":
+ {
+ "test1property1": ...,
+ "test1property2": ...,
+ ...
+ },
+ "test2name":
+ {
+ "test2property1": ...,
+ "test2property2": ...,
+ ...
+ }
+}
+```
+
+Arrays are allowed, but don't use them for sets of properties - only use them for data that is clearly a continuous contiguous sequence of values.
+