src/cm/templates/api_doc.html
changeset 298 f6dab88267b7
parent 287 fc5ed157ebfe
equal deleted inserted replaced
297:173710f4b6d1 298:f6dab88267b7
    35 The API exposes method for external application to deal with content store in COMT.
    35 The API exposes method for external application to deal with content store in COMT.
    36 
    36 
    37 The authentification is done using <a href="http://fr.wikipedia.org/wiki/HTTP_Authentification">HTTP Authentification</a>.
    37 The authentification is done using <a href="http://fr.wikipedia.org/wiki/HTTP_Authentification">HTTP Authentification</a>.
    38 
    38 
    39 The default return format is 'json', add '?format=other_format' where other_format is 'json', 'xml', 'yaml' to change the results' format. 
    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 
    40 
    42 		{% regroup docs by type as grouped_docs %}
    41 		{% regroup docs by type as grouped_docs %}
    43 
    42 
    44 		
    43 		
    45 		{% for dd in grouped_docs %}
    44 		{% for dd in grouped_docs %}
    48 			{% if not doc.handler.no_display %}
    47 			{% 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>
    48 			<h3>{{ doc.handler.title }}&nbsp;<a href="#{{ doc.handler.title|iriencode }}" class="reflink" title="Permalink" name="{{ doc.handler.title|iriencode }}">¶</a></h3>
    50 			
    49 			
    51 			<p>{{ doc.handler.desc }}</p>
    50 			<p>{{ doc.handler.desc }}</p>
    52 			<p>
    51 			<p>
    53 				{{ doc.doc|default:""|restructuredtext }}
    52 				{{ doc.doc|default:"" }}
    54 			</p>
    53 			</p>
    55 			
    54 			
    56 			<p>
    55 			<p>
    57 				Endpoint: <b>{{ doc.handler.endpoint }}</b>
    56 				Endpoint: <b>{{ doc.handler.endpoint }}</b>
    58 			</p>
    57 			</p>