diff -r b5deb8e32219 -r fc5ed157ebfe src/cm/templates/api_doc.html --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/src/cm/templates/api_doc.html Fri Jul 09 10:05:29 2010 +0200 @@ -0,0 +1,75 @@ +{% extends "site/layout/base_workspace.html" %} +{% load com %} +{% load i18n %} + +{% block title %} +{% blocktrans %}API Documentation{% endblocktrans %} +{% endblock %} + +{% block head %} +{% endblock %} + +{% block content %} + + + + + + +

API Documentation

+ +

Presentation

+ +The API exposes method for external application to deal with content store in COMT. + +The authentification is done using HTTP Authentification. + +The default return format is 'json', add '?format=other_format' where other_format is 'json', 'xml', 'yaml' to change the results' format. +{% load markup %} + + {% regroup docs by type as grouped_docs %} + + + {% for dd in grouped_docs %} +

{{ dd.grouper }}

+ {% for doc in dd.list %} + {% if not doc.handler.no_display %} +

{{ doc.handler.title }} ΒΆ

+ +

{{ doc.handler.desc }}

+

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

+ +

+ Endpoint: {{ doc.handler.endpoint }} +

+ +

+ Method: {% for meth in doc.allowed_methods %}{{ meth }}{% if not forloop.last %}, {% endif %}{% endfor %} +

+ +

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

+ + +
+ {% endif %} + {% endfor %} + {% endfor %} + + +{% endblock %}