From 0a03fcd9cd508514a6e2d5e3a6bb62bae6252331 Mon Sep 17 00:00:00 2001 From: Bastien Wirtz Date: Tue, 11 Oct 2022 19:19:50 +0200 Subject: Docs for dummy data --- dummy-data/README.md | 15 +++++++++++++++ 1 file changed, 15 insertions(+) create mode 100644 dummy-data/README.md 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 @@ +# Dummy data + +This directory content makes possible to test custom services cards or create a demo without actually running the service. +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. + +## How to add a new services sample: + +- create a directory for your service, and any sub-folder existing in the service api path. +- save the api output in a file named after the service endpoint. + +Example: +``` +mkdir pihole +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) +``` \ No newline at end of file -- cgit v1.2.3