{% extends "docs/docs_base.html" %}

{% block doc_title %}Crash Reporting Dictionary / {{ dataset }} / {{ field_name }}{% endblock %}

{% block main_content %}
  <div class="panel">
    <div class="body">
      <p>
        <a href="{{ url('documentation:datadictionary_index') }}">Crash Reporting Data Dictionary</a>
        / {{ dataset }}
        {% for breadcrumb in field_path_breadcrumbs %}
          {% if breadcrumb[1] == "[]" %}
            / []
          {% else %}
            / <a href="{{ url('documentation:datadictionary_field_doc', dataset, breadcrumb[0]) }}">{{ breadcrumb[1] }}</a>
          {% endif %}
        {% endfor %}
      </p>
      <h1>{{ field_name }}</h1>
      <table class="record data-table hard-wrapped">
        <tbody>
          <tr>
            <th class="w-2/12" scope="row">dataset</th>
            <td class="w-10/12">{{ dataset }}</td>
          </tr>
          <tr>
            <th scope="row">description</th>
            <td>{{ description | safe }}</td>
          </tr>
          <tr>
            <th scope="row">type</th>
            <td>{{ type }}</td>
          </tr>
          {% if "array" in type %}
            <tr>
              <th scope="row">array contents</th>
              <td>
                {% if "object" not in field_data.get("items", {}).get("type", "") %}
                  {{ field_data.get("items", {}).get("type") }}
                {% else %}
                  <ul>
                    {% for arrayfield in field_data["items"].get("properties", []) %}
                      <li><a href="{{ url("documentation:datadictionary_field_doc", dataset, field_path + "/[]/" + arrayfield) }}">{{ arrayfield }}</a></li>
                    {% endfor %}
                  </ul>
                {% endif %}
              </td>
            </tr>
          {% elif "object" in type %}
            <tr>
              <th scope="row">object contents</th>
              <td>
                <ul>
                  {% for objectname in field_data.get("properties", {}).keys() %}
                    <li><a href="{{ url("documentation:datadictionary_field_doc", dataset, field_path + "/" + objectname) }}">{{ objectname }}</a></li>

                  {% endfor %}
                  {% for objectfield in field_data.get("pattern_properties", {}).values() %}
                    <li><a href="{{ url("documentation:datadictionary_field_doc", dataset, field_path + "/" + objectfield["nickname"] ) }}">{{ objectfield["nickname"] }}</a></li>
                  {% endfor %}
                </ul>
              </td>
            </tr>
          {% endif %}
          {% if dataset == "processed" %}
            {% if search_field %}
              <tr>
                <th scope="row">super search field</th>
                <td>
                  <code>{{ search_field }}</code>
                  ({{ search_field_query_type }})
                </td>
              </tr>
              <tr>
                <th scope="row">example data from last 7 days</th>
                <td>
                  {% if example_data %}
                    {% for item in example_data %}
                      <div class="field-example"><code>{{ item|string|truncate(100, killwords=True, end="...") }}</code></div>
                    {% endfor %}
                  {% elif "protected" in permissions %}
                    <i>This field is not public. No examples will be shown.</i>
                  {% else %}
                    <i>
                      No examples available. Either this field is new and has
                      no data or this field is rarely emitted and has no data
                      this week or this field is not configured to allow it to
                      be used for aggregations in Elasticsearch.
                    </i>
                  {% endif %}
                </td>
              </tr>
            {% else %}
              <tr>
                <th scope="row">super search field</th>
                <td><i>This field is not indexed.</i></td>
              </tr>
            {% endif %}
            {% if source_annotation %}
              <tr>
                <th scope="row">source annotation</th>
                <td>
                  <code>
                    <a href="{{ url('documentation:datadictionary_field_doc', 'annotation', source_annotation) }}">
                      {{ source_annotation }}
                    </a>
                  </code>
                </td>
              </tr>
            {% endif %}
          {% endif %}
          {% if dataset == "annotation" %}
            <tr>
              <th scope="row">data reviews</th>
              <td>
                <ul>
                  {% for thing in data_reviews %}
                    {% if thing.startswith("http") %}
                      <li><a href="{{ thing }}">{{ thing }}</a></li>
                    {% else %}
                      <li>{{ thing }}</li>
                    {% endif %}
                  {% endfor %}
                </ul>
              </td>
            </tr>
            <tr>
              <th scope="row">related processed field</th>
              <td>
                {% if processed_field %}
                  <code>
                    <a href="{{ url('documentation:datadictionary_field_doc', 'processed', processed_field) }}">
                      {{ processed_field }}
                    </a>
                  </code>
                {% endif %}
              </td>
            </tr>
            <tr>
              <th scope="row">products that emitted this field in last 7 days</th>
              <td>
                {% if products_for_field %}
                  {{ products_for_field|join(', ') }}
                {% else %}
                  <i>None.</i>
                {% endif %}
              </td>
            </tr>
          {% endif %}
          <tr>
            <th scope="row">permissions</th>
            <td>
              <p>{{ permissions|join(', ') }}</p>
              {% if "protected" in permissions %}
              <p>
                <i>
                  This field is protected data. See <a href="{{ url('documentation:protected_data_access') }}">Protected Data Access</a> for details.
                </i>
              </p>
              {% endif %}
            </td>
          </tr>
        </tbody>
      </table>
      <p>
        Do you see errors in this documentation?
        <a href="https://bugzilla.mozilla.org/enter_bug.cgi?bug_type=task&component=General&form_name=enter_bug&op_sys=Unspecified&product=Socorro&rep_platform=Unspecified&short_desc=improve%20documentation%20for%20field%20FIELD&version=unspecified">Please tell us by filing a bug</a>
        or
        {% if dataset == "annotation" %}
          <a href="https://github.com/mozilla-services/socorro/blob/main/socorro/schemas/raw_crash.schema.yaml">
            fix the field data in the raw crash schema
          </a>.
        {% elif dataset == "processed" %}
          <a href="https://github.com/mozilla-services/socorro/blob/main/socorro/schemas/processed_crash.schema.yaml">
            fix the field data in the processed crash schema
          </a>.
        {% endif %}
      </p>
    </div>
  </div>
{% endblock %}