1 {% extends "site/layout/base_workspace.html" %}

     2 {% load com %}

     3 {% load i18n %}

     4 

     5 {% block title %}

     6 {% blocktrans %}API Documentation{% endblocktrans %}

     7 {% endblock %}

     8 

     9 {% block head %}

    10 {% endblock %}

    11 

    12 {% block content %}

    13 

    14 

    15 

    16   <style type="text/css" media="screen">

    17 a.reflink {

    18 color:#C60F0F;

    19 font-size:0.8em;

    20 padding:0 4px;

    21 text-decoration:none;

    22 visibility:hidden;

    23 }

    24 

    25 :hover > a.reflink {

    26 visibility:visible;

    27 }

    28   </style>

    29 

    30 

    31 <h1>API Documentation</h1>

    32 

    33 <h2>Presentation</h2>

    34 

    35 The API exposes method for external application to deal with content store in COMT.

    36 

    37 The authentification is done using <a href="http://fr.wikipedia.org/wiki/HTTP_Authentification">HTTP Authentification</a>.

    38 

    39 The default return format is 'json', add '?format=other_format' where other_format is 'json', 'xml', 'yaml' to change the results' format. 

    40 {% load markup %}

    41 

    42 		{% regroup docs by type as grouped_docs %}

    43 

    44 		

    45 		{% for dd in grouped_docs %}

    46 			<h2>{{ dd.grouper }}</h2>

    47 		    {% for doc in dd.list %}

    48 			{% if not doc.handler.no_display %}

    49 			<h3>{{ doc.handler.title }}&nbsp;<a href="#{{ doc.handler.title|iriencode }}" class="reflink" title="Permalink" name="{{ doc.handler.title|iriencode }}">¶</a></h3>

    50 			

    51 			<p>{{ doc.handler.desc }}</p>

    52 			<p>

    53 				{{ doc.doc|default:""|restructuredtext }}

    54 			</p>

    55 			

    56 			<p>

    57 				Endpoint: <b>{{ doc.handler.endpoint }}</b>

    58 			</p>

    59 			

    60 			<p>

    61 				Method: {% for meth in doc.allowed_methods %}<b>{{ meth }}</b>{% if not forloop.last %}, {% endif %}{% endfor %}

    62 			</p>

    63 

    64 			<p>

    65 				Args: {% if doc.handler.args %}{{ doc.handler.args|safe }}{% else %}None{% endif %}

    66 			</p>

    67 			

    68 					

    69 			<br />		

    70 			{% endif %}		

    71 			{% endfor %}

    72 		{% endfor %}

    73 	</body>

    74 </html>

    75 {% endblock %}