aboutsummaryrefslogtreecommitdiffhomepage
path: root/dummy-data/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'dummy-data/README.md')
-rw-r--r--dummy-data/README.md13
1 files changed, 7 insertions, 6 deletions
diff --git a/dummy-data/README.md b/dummy-data/README.md
index eeff4ec..6db4712 100644
--- a/dummy-data/README.md
+++ b/dummy-data/README.md
@@ -1,15 +1,16 @@
1# Dummy data 1# Dummy data
2 2
3This directory content makes possible to test custom services cards or create a demo without actually running the service. 3This directory content makes possible to test custom services cards or create a demo without actually running the service.
4The 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. 4The 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 5
6## How to add a new services sample: 6## How to add a new services sample
7 7
8- create a directory for your service, and any sub-folder existing in the service api path. 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. 9- save the api output in a file named after the service endpoint.
10 10
11Example: 11Example:
12``` 12
13```sh
13mkdir pihole 14mkdir pihole
14curl http://my-pihole.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) 15curl http://my-pihole.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 `endpoint` property)
15``` \ No newline at end of file 16```