Mercurial > p > roundup > code
view website/issues/html/keyword.item.html @ 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 | eff9c5435acc |
| children |
line wrap: on
line source
<!-- dollarId: keyword.item,v 1.3 2002/05/22 00:32:34 richard Exp dollar--> <tal:block metal:use-macro="templates/page/macros/icing"> <title metal:fill-slot="head_title" i18n:translate="">Keyword editing - <span i18n:name="tracker" tal:replace="config/TRACKER_NAME" /></title> <span metal:fill-slot="body_title" tal:omit-tag="python:1" i18n:translate="">Keyword editing</span> <td class="content" metal:fill-slot="content"> <table class="otherinfo" tal:define="keywords db/keyword/list" tal:condition="keywords"> <tr><th colspan="4" class="header" i18n:translate="">Existing Keywords</th></tr> <tr tal:repeat="start python:range(0, len(keywords), 4)"> <td width="25%" tal:define="batch python:utils.Batch(keywords, 4, start)" tal:repeat="keyword batch"> <a tal:attributes="href string:keyword${keyword/id}" tal:content="keyword/name">keyword here</a> </td> </tr> <tr> <td colspan="4" style="border-top: 1px solid gray" i18n:translate=""> To edit an existing keyword (for spelling or typing errors), click on its entry above. </td> </tr> </table> <p class="help" tal:condition="not:context/id" i18n:translate=""> To create a new keyword, enter it below and click "Submit New Entry". </p> <form method="POST" onSubmit="return submit_once()" enctype="multipart/form-data" tal:attributes="action context/designator"> <table class="form"> <tr> <th i18n:translate="">Keyword</th> <td tal:content="structure python:context.name.field(size=60)">name</td> </tr> <tr> <th class="required" i18n:translate="">Description:</th> <td tal:content="structure python:context.description.field(size=60)">description</td> </tr> <tr> <td tal:condition="not:context/id"> <tal:comment tal:replace="nothing"> If we get here and do not have an id, we are creating a new keyword. It would be nice to provide some mechanism to determine the preferred state of the "Continue adding keywords" checkbox. By default I have it enabled. </tal:comment> <input type="checkbox" id="continue_new_keyword" name="__redirect_to" tal:attributes="value string:${request/base}${request/env/PATH_INFO}?@template=item; checked python:True" /> <label for="continue_new_keyword" i18n:translate="">Continue adding keywords.</label> </td> </tr> <tr> <td> <input type="hidden" name="@required" value="name"> <input type="hidden" name="@template" value="item"> </td> <td colspan=3 tal:content="structure context/submit"> submit button will go here </td> </tr> </table> </form> </td> </tal:block>
