{% render_markdown document.description %}
+{% code bash %}# Load the schema document
+$ coreapi get {{ schema_url }}{% if schema_format %} --format {{ schema_format }}{% endif %}
+
+# Interact with the API endpoint
+$ coreapi action {% if section_key %}{{ section_key }} {% endif %}{{ link_key }}{% for field in link.fields %} -p {{ field.name }}=...{% endfor %}{% endcode %}
+ {{ link.action|upper }} {{ link.url }}
+
{% render_markdown link.description %}
+ +{% if link.fields|with_location:'path' %} +The following parameters should be included in the URL path.
+| Parameter | Description |
|---|---|
{{ field.name }}{% if field.required %} required{% endif %} | {% if field.description %}{{ field.description }}{% endif %} |
The following parameters should be included as part of a URL query string.
+| Parameter | Description |
|---|---|
{{ field.name }}{% if field.required %} required{% endif %} | {% if field.description %}{{ field.description }}{% endif %} |
The following parameters should be included as HTTP headers.
+| Parameter | Description |
|---|---|
{{ field.name }}{% if field.required %} required{% endif %} | {% if field.description %}{{ field.description }}{% endif %} |
The request body should be "{{ link.encoding }}" encoded, and should contain a single item.
| Parameter | Description |
|---|---|
{{ field.name }}{% if field.required %} required{% endif %} | {% if field.description %}{{ field.description }}{% endif %} |
The request body should be a "{{ link.encoding }}" encoded object, containing the following items.
| Parameter | Description |
|---|---|
{{ field.name }}{% if field.required %} required{% endif %} | {% if field.description %}{{ field.description }}{% endif %} |
%s'
+ LANG_TAG = ' class="highlight %s"'
+
+
+class FencedCodeExtension(markdown.Extension):
+
+ def extendMarkdown(self, md, md_globals):
+ """ Add FencedBlockPreprocessor to the Markdown instance. """
+ md.registerExtension(self)
+
+ md.preprocessors.add('fenced_code_block',
+ CustomFencedBlockPreprocessor(md),
+ ">normalize_whitespace")
+
+
+from pygments import highlight
+from pygments.lexers import get_lexer_by_name
+from pygments.formatters import HtmlFormatter
+
+
+@register.tag(name='code')
+def do_code(parser,token):
+ code = token.split_contents()[-1]
+ nodelist = parser.parse(('endcode',))
+ parser.delete_first_token()
+ return CodeNode(code, nodelist)
+
+
+class CodeNode(template.Node):
+ style = 'default'
+
+ def __init__(self, lang, code):
+ self.lang = lang
+ self.nodelist = code
+
+ def render(self, context):
+ body = self.nodelist.render(context)
+ lexer = get_lexer_by_name(self.lang, stripall=False)
+ formatter = HtmlFormatter(nowrap=True, style=self.style)
+ code = highlight(body, lexer, formatter)
+ return code
+
+
+@register.filter()
+def with_location(fields, location):
+ return [
+ field for field in fields
+ if field.location == location
+ ]
+
+
+@register.simple_tag
+def form_for_link(link):
+ import coreschema
+ properties = {
+ field.name: field.schema or coreschema.String()
+ for field in link.fields
+ }
+ required = [
+ field.name
+ for field in link.fields
+ if field.required
+ ]
+ schema = coreschema.Object(properties=properties, required=required)
+ return coreschema.render_to_form(schema)
+
+
+@register.simple_tag
+def render_markdown(markdown_text):
+ return markdown.markdown(markdown_text, extensions=[FencedCodeExtension(), "tables"])
+
+
@register.simple_tag
def get_pagination_html(pager):
return pager.to_html()