Commit 1d404638861cb10fc3f0c75079f4731d09b41c47
1 parent
6f0134bf
Exists in
master
and in
39 other branches
Removing api old docs
Showing
1 changed file
with
3 additions
and
73 deletions
Show diff stats
src/templates/open-data.html
| ... | ... | @@ -2,77 +2,7 @@ |
| 2 | 2 | {% load i18n %} |
| 3 | 3 | |
| 4 | 4 | {% block main-content %} |
| 5 | - <div> | |
| 6 | - <h2>{% trans "OpenData - Communities Interlegis" %}</h2> | |
| 7 | - <p>{% blocktrans %}At this point the system Colab provides much of its data | |
| 8 | - through its search engine.{% endblocktrans %}</p> | |
| 9 | - <p>{% blocktrans %}If you are interested in integrating your system with the environment Colab | |
| 10 | - and requires no other data provided by this API, please contact us via the ticketing | |
| 11 | - system (you must be registered in order to create a ticket).{% endblocktrans %}</p> | |
| 12 | - | |
| 13 | - <h3>{% trans "Performing searches via the API" %}</h3> | |
| 14 | - <p>{% trans "The Colab API searches works through an HTTP/REST always returning JSON objects with result." %} </p> | |
| 15 | - <p>{% trans "The base URL used for the search is:" %} | |
| 16 | - <a href="/api/search/">http://colab.interlegis.leg.br/api/search/</a></p> | |
| 17 | - | |
| 18 | - <h3>{% trans "Parameters:" %}</h3> | |
| 19 | - <ul class="none indent-dois"> | |
| 20 | - <li> | |
| 21 | - <h4><i>{% trans "Query" %}</i> - q</h4> | |
| 22 | - {% blocktrans %}The <i>query</i> is the "question" sent | |
| 23 | - to the search server. A <i>query</i> consists of | |
| 24 | - <b>field:value</b>, where the field represents a kind of system data, | |
| 25 | - for example <b>collaborator</b> and represents the data stored | |
| 26 | - by the system, for example <b>jeanferri</b>.{% endblocktrans %} | |
| 27 | - {% trans "The following is a list of available fields to search:" %}<br/> | |
| 28 | - <ul class="none indent-dois"> | |
| 29 | - <li><b>Type</b>: {% trans "wiki, thread, ticket, changeset." %}</li> | |
| 30 | - <li><b>Title</b>: {% trans "page name, title of the discussion or ticket, changeset description." %}</li> | |
| 31 | - <li><b>Description</b>: {% trans "excerpt from the page or the discussion, description of the ticket or changeset." %}</li> | |
| 32 | - <li><b>Creator</b>: {% trans "name of user who created the document." %}</li> | |
| 33 | - <li><b>creator_real_name</b>: {% trans "real name who created the document." %}</li> | |
| 34 | - <li><b>create</b>: {% trans "creation date." %}</li> | |
| 35 | - <li><b>modified</b>: {% trans "modification date." %}</li> | |
| 36 | - <li><b>mailinglist</b>: {% trans "mailing list (only for type thread)." %}</li> | |
| 37 | - <li><b>name</b>: {% trans "name of the wiki page." %}</li> | |
| 38 | - <li><b>comment</b>: {% trans "comments of tickets (all concatenated)." %}</li> | |
| 39 | - <li><b>content</b>: {% trans "contents of wiki page or messages of the discussions (all concatenated)." %} </li> | |
| 40 | - <li><b>keyword</b>: {% trans "keywords (ticket only)." %}</li> | |
| 41 | - <li><b>milestone</b>: {% trans "milestone (ticket only)." %}</li> | |
| 42 | - <li><b>priority</b>: {% trans "priority (ticket only)." %}</li> | |
| 43 | - <li><b>component</b>: {% trans "component (ticket only)." %}</li> | |
| 44 | - <li><b>version</b>: {% trans "version (ticket only)." %}</li> | |
| 45 | - <li><b>severity</b>: {% trans "severity (ticket only)." %}</li> | |
| 46 | - <li><b>owner</b>: {% trans "responsible (ticket only)." %}</li> | |
| 47 | - <li><b>status</b>: {% trans "status (ticket only)." %}</li> | |
| 48 | - <li><b>revision</b>: {% trans "review (ticket only)." %}</li> | |
| 49 | - <li><b>subject</b>: {% trans "synonym for the title (for discussion)." %}</li> | |
| 50 | - </ul> | |
| 51 | - </li> | |
| 52 | - <br/><hr/> | |
| 53 | - | |
| 54 | - <li> | |
| 55 | - <h4>{% trans "Results per page - n" %} </h4> | |
| 56 | - {% blocktrans %}Number of results to be displayed per page. | |
| 57 | - Its value must be an integer between 1 and 500.{% endblocktrans %} | |
| 58 | - <i>{% trans "Default: 50" %}</i>. | |
| 59 | - </li> | |
| 60 | - <br/><hr/> | |
| 61 | - | |
| 62 | - <li> | |
| 63 | - <h4>{% trans "Page - p" %}</h4> | |
| 64 | - {% blocktrans %}Page number that appears. Its value must be an | |
| 65 | - integer equal to or greater than 1.{% endblocktrans %} <i>{% trans "Default: 1" %}</i>. | |
| 66 | - </li> | |
| 67 | - <br/><hr/> | |
| 68 | - | |
| 69 | - <li> | |
| 70 | - <h4>{% trans "Order - o" %}</h4> | |
| 71 | - {% blocktrans %}Order in which the results will be displayed. Its value must be | |
| 72 | - a string in the <b>field direction</b> where the same field are | |
| 73 | - presented in the <i>query</i> parameter and direction can be | |
| 74 | - <b>asc</b> for ascending or <b>desc</b> for descending.{% endblocktrans %} <i>Default: score desc</i>. | |
| 75 | - </li> | |
| 76 | - <br/> | |
| 77 | - </ul> | |
| 5 | + <h2>{% trans "OpenData - Communities Interlegis" %}</h2> | |
| 6 | + <br> | |
| 7 | + <h3>{% trans 'Soon...'%}</h3> | |
| 78 | 8 | {% endblock %} | ... | ... |