diff --git a/docs/easycozy/tips.md b/docs/easycozy/tips.md new file mode 100644 index 0000000000000000000000000000000000000000..251eb290ce3ade170c0038350f5a672ad9fd0414 --- /dev/null +++ b/docs/easycozy/tips.md @@ -0,0 +1,38 @@ +# Tips + +## Query data from an instance + +For maintenance reason, we sometime need to check data on a specific instance. For that we use postman to send get / post / delete data. +All posibility are described in the [data section of Cozy documentation](https://docs.cozy.io/en/cozy-stack/data-system/). + +**Example** + +The example will describ how to query userChallenge data from an instance. +First, you need to be able to connect to the instance in order to retrive the bearer and the cozysessid. + + + +Then use postman to query the data: +``` +Verb: GET +Request: https://ecolyotest.cozy.self-data.alpha.grandlyon.com/data/com.grandlyon.ecolyo.userchallenge/_all_docs?include_docs=true +Header: + Accept: application/json + content-type: application/json + Authorization: Bearer xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx + Cookie: cozysessid=AAAAAxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx +``` + +The result will then be retrieve by postman: +``` +{ + "total_rows": 1, + "offset": 0, + "rows": [ + { + "id": "a353b985c0c5f09229b0acd6b2f37f1b", + "key": "a353b985c0c5f09229b0acd6b2f37f1b", + ... + ] +} +``` \ No newline at end of file diff --git a/mkdocs.yml b/mkdocs.yml index 8a682782d3df81277f1718e843f3767a00644bf4..c9c50c6c9d1f94f920e0cbb35cd83a0b36297534 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -27,6 +27,7 @@ nav: - Easy Cozy: - Scripts: easycozy/scripts.md - Commands: easycozy/commands.md + - Tips: easycozy/tips.md - Ecolyo: - Introduction: ecolyo/index.md - Getting started: