diff options
author | Shagon94 <Shagon94@gmail.com> | 2022-10-30 18:32:51 +0100 |
---|---|---|
committer | GitHub <noreply@github.com> | 2022-10-30 10:32:51 -0700 |
commit | cfd31b86b5a71d059dd9b6f24f0df5b20ac9c0ca (patch) | |
tree | e7df4c2311358aeb85e6bf52e0d4a56b06f3bf4c /dummy-data/README.md | |
parent | ac5f04f058344be4eb61bcc8684771973f18bc71 (diff) | |
download | homer-cfd31b86b5a71d059dd9b6f24f0df5b20ac9c0ca.tar.gz homer-cfd31b86b5a71d059dd9b6f24f0df5b20ac9c0ca.tar.zst homer-cfd31b86b5a71d059dd9b6f24f0df5b20ac9c0ca.zip |
qBittorrent service (#540)
qBittorrent service
Diffstat (limited to 'dummy-data/README.md')
-rw-r--r-- | dummy-data/README.md | 13 |
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 | ||
3 | This directory content makes possible to test custom services cards or create a demo without actually running the service. | 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. | 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 | 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 | ||
11 | Example: | 11 | Example: |
12 | ``` | 12 | |
13 | ```sh | ||
13 | mkdir pihole | 14 | mkdir pihole |
14 | curl 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) | 15 | curl 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 | ``` |