{% extends "base.html" %}

{% block title %}The {{ object.name }} object{% endblock %}

{% block content %}
<p class="breadcrumb">
    <a href="{% relative_url 'homepage' %}">{{ SITE_OPTIONS.site_name }}</a> &gt;
    <a href="{% relative_url_string object.schema.reference_url %}">{{ object.schema.name }} reference</a> &gt;
    <a href="{% relative_url_string object.schema.json_objects_url %}">Objects</a> &gt;
    {{ object.name }}
</p>

<h1>The {{ object.name }} object</h1>

<p><b>Type:</b> {{ object.pretty_object_type }}</p>

{% if object.description %}
{{ object.description|safe }}
{% endif %}

{% if child_relationships %}
<h2>Keys:</h2>

<table>
<thead>
<tr>
    <th>Name</th>
    <th>Type</th>
    <th>Required?</th>
    <th>Description</th>
</tr>
</thead>

{% for rel in child_relationships %}
<tr>
    <td><nobr><b>"{{ rel.child_key }}"</b></nobr></td>
    <td>
        {% if rel.child.is_array %}
            An array of
            {% for childrel in rel.child.get_child_relationships %}
            <a href="{% relative_url_string childrel.child.get_absolute_url %}">{{ childrel.child.name }} objects</a>{% if not forloop.last %}, {% endif %}
            {% endfor %}
        {% elif rel.child.is_literal_string %}
            The string <code>"{{ rel.child.description }}"</code>
        {% else %}
        <a href="{% relative_url_string rel.child.get_absolute_url %}">{{ rel.child.name }} object</a>
        {% endif %}
    </td>
    <td>{{ rel.is_required|yesno|title }}</td>
    <td>{{ rel.description|safe|linebreaksbr }}</td>
</tr>
{% endfor %}

</table>
{% endif %}

{% if enum_values %}
<h2>Allowed values:</h2>

<table>
<thead>
<tr>
    <th>Value</th>
    <th>Description</th>
</tr>
</thead>
{% for enum_value in enum_values %}
<tr>
    <td><nobr><b>"{{ enum_value.name }}"</b></nobr></td>
    <td>{{ enum_value.description|safe|linebreaksbr }}</td>
</tr>
{% endfor %}
</table>
{% endif %}

{% if examples %}
<h2 id="examples">Examples</h2>

<p>This object is used in the following examples:</p>
<p>
    {% for example in examples %}<nobr><a href="{% relative_url_string example.example.get_absolute_url %}">{{ example.example.name }}</a></nobr>{% if not forloop.last %}, {% endif %}{% endfor %}
</p>
{% endif %}

{% endblock %}