Mercurial > p > roundup > code
annotate doc/debugging.txt @ 5639:f576957cbb1f
Add support for prev/next/self links when returning paginated results.
To do this:
1) change "data" envelope from an array to a dict
2) move the "data" array to the "collection" property,
which is an array of elements in the collection.
3) add @links dict keyed by link relation: self, next, prev.
Each relation is an array of dicts with uri and rel keys.
In this case there is only one element, but there is nothing
preventing a relation from having multiple url's. So this follows
the formatting needed for the general case.
Relations are present only if it makes sense. So first page has no
prev and last page has no next.
4) add @total_size with number of element selected if they were
not paginated. Replicates data in X-Count-Total header.
Changed index to start at 1. So the first page is page_index 1 and not
page_index 0. (So I am no longer surprised when I set page_index to 1
and am missing a bunch of records 8-)).
Also a small fixup, json response ends with a newline so printing
the data, or using curl makes sure that anything printing after the
json output (like shell prompts) is on a new line.
Tests added for all cases.
| author | John Rouillard <rouilj@ieee.org> |
|---|---|
| date | Sat, 09 Mar 2019 11:06:10 -0500 |
| parents | b6f1aaba4827 |
| children | a635a60ffb84 |
| rev | line source |
|---|---|
|
4377
b6f1aaba4827
Small documentation update regarding debugging aids:
Bernhard Reiter <Bernhard.Reiter@intevation.de>
parents:
1836
diff
changeset
|
1 Debugging Aids |
|
b6f1aaba4827
Small documentation update regarding debugging aids:
Bernhard Reiter <Bernhard.Reiter@intevation.de>
parents:
1836
diff
changeset
|
2 -------------- |
|
1836
94e430ad4fdb
make the RDBMS common backend and the SQLite and MYsql backend create...
Anthony Baxter <anthonybaxter@users.sourceforge.net>
parents:
diff
changeset
|
3 |
|
4377
b6f1aaba4827
Small documentation update regarding debugging aids:
Bernhard Reiter <Bernhard.Reiter@intevation.de>
parents:
1836
diff
changeset
|
4 Try turning on logging of DEBUG level messages. This may be done a number |
|
b6f1aaba4827
Small documentation update regarding debugging aids:
Bernhard Reiter <Bernhard.Reiter@intevation.de>
parents:
1836
diff
changeset
|
5 of ways, depending on what it is you're testing: |
|
1836
94e430ad4fdb
make the RDBMS common backend and the SQLite and MYsql backend create...
Anthony Baxter <anthonybaxter@users.sourceforge.net>
parents:
diff
changeset
|
6 |
|
4377
b6f1aaba4827
Small documentation update regarding debugging aids:
Bernhard Reiter <Bernhard.Reiter@intevation.de>
parents:
1836
diff
changeset
|
7 1. If you're testing the database unit tests, then set the environment |
|
b6f1aaba4827
Small documentation update regarding debugging aids:
Bernhard Reiter <Bernhard.Reiter@intevation.de>
parents:
1836
diff
changeset
|
8 variable ``LOGGING_LEVEL=DEBUG``. This may be done like so: |
|
1836
94e430ad4fdb
make the RDBMS common backend and the SQLite and MYsql backend create...
Anthony Baxter <anthonybaxter@users.sourceforge.net>
parents:
diff
changeset
|
9 |
|
4377
b6f1aaba4827
Small documentation update regarding debugging aids:
Bernhard Reiter <Bernhard.Reiter@intevation.de>
parents:
1836
diff
changeset
|
10 LOGGING_LEVEL=DEBUG python run_tests.py |
|
1836
94e430ad4fdb
make the RDBMS common backend and the SQLite and MYsql backend create...
Anthony Baxter <anthonybaxter@users.sourceforge.net>
parents:
diff
changeset
|
11 |
|
4377
b6f1aaba4827
Small documentation update regarding debugging aids:
Bernhard Reiter <Bernhard.Reiter@intevation.de>
parents:
1836
diff
changeset
|
12 This variable replaces the older HYPERDBDEBUG environment var. |
|
1836
94e430ad4fdb
make the RDBMS common backend and the SQLite and MYsql backend create...
Anthony Baxter <anthonybaxter@users.sourceforge.net>
parents:
diff
changeset
|
13 |
|
4377
b6f1aaba4827
Small documentation update regarding debugging aids:
Bernhard Reiter <Bernhard.Reiter@intevation.de>
parents:
1836
diff
changeset
|
14 2. If you're testing a particular tracker, then set the logging level in |
|
b6f1aaba4827
Small documentation update regarding debugging aids:
Bernhard Reiter <Bernhard.Reiter@intevation.de>
parents:
1836
diff
changeset
|
15 your tracker's ``config.ini``. |
|
1836
94e430ad4fdb
make the RDBMS common backend and the SQLite and MYsql backend create...
Anthony Baxter <anthonybaxter@users.sourceforge.net>
parents:
diff
changeset
|
16 |
|
94e430ad4fdb
make the RDBMS common backend and the SQLite and MYsql backend create...
Anthony Baxter <anthonybaxter@users.sourceforge.net>
parents:
diff
changeset
|
17 SENDMAILDEBUG |
|
94e430ad4fdb
make the RDBMS common backend and the SQLite and MYsql backend create...
Anthony Baxter <anthonybaxter@users.sourceforge.net>
parents:
diff
changeset
|
18 ============= |
|
94e430ad4fdb
make the RDBMS common backend and the SQLite and MYsql backend create...
Anthony Baxter <anthonybaxter@users.sourceforge.net>
parents:
diff
changeset
|
19 |
|
4377
b6f1aaba4827
Small documentation update regarding debugging aids:
Bernhard Reiter <Bernhard.Reiter@intevation.de>
parents:
1836
diff
changeset
|
20 Set to a filename and roundup will write each email message |
|
b6f1aaba4827
Small documentation update regarding debugging aids:
Bernhard Reiter <Bernhard.Reiter@intevation.de>
parents:
1836
diff
changeset
|
21 that it sends to that file instead to the internet. |
|
b6f1aaba4827
Small documentation update regarding debugging aids:
Bernhard Reiter <Bernhard.Reiter@intevation.de>
parents:
1836
diff
changeset
|
22 This environment variable is independent of the python -O flag. |
|
1836
94e430ad4fdb
make the RDBMS common backend and the SQLite and MYsql backend create...
Anthony Baxter <anthonybaxter@users.sourceforge.net>
parents:
diff
changeset
|
23 |
