diff options
-rw-r--r-- | dummy-data/README.md | 15 |
1 files changed, 15 insertions, 0 deletions
diff --git a/dummy-data/README.md b/dummy-data/README.md new file mode 100644 index 0000000..deed875 --- /dev/null +++ b/dummy-data/README.md | |||
@@ -0,0 +1,15 @@ | |||
1 | # Dummy data | ||
2 | |||
3 | This directory content makes possible to test custom services cards or create a demo without actually running the service. | ||
4 | The principle is simple: save a sample output of the API used in the service in a static file in this directory. The path must be identical as the service endpoint to be used seamlessly. | ||
5 | |||
6 | ## How to add a new services sample: | ||
7 | |||
8 | - create a directory for your service, and any sub-folder existing in the service api path. | ||
9 | - save the api output in a file named after the service endpoint. | ||
10 | |||
11 | Example: | ||
12 | ``` | ||
13 | mkdir pihole | ||
14 | curl http://my-pihile.me/admin/api.php -o pihole/api.php # /admin is omited because for PiHole, the implementation expect it to be in the base url (`url` or `enpoint` property) | ||
15 | ``` \ No newline at end of file | ||