templates/Doc/error.html.twig line 1

Open in your IDE?
  1. {% extends 'Layouts/Doc/default.html.twig' %}
  3. {% block title %}Documentation
  4. {% endblock %}
  6. {% block headerPageTitle %}
  7.     {{ 'app.documentation.page.title.error'|trans |upper}}
  8. {% endblock %}
  10. {% macro renderTree(node, level) %}
  11.     {% set badgeClass = {
  12.         0: 'light-primary',
  13.         1: 'light-info',
  14.         2: 'light-warning',
  15.         3: 'light-success',
  16.         4: 'secondary',
  17.     }[level]|default('secondary') %}
  19.     <li class="list-group-item">
  20.         <span class="d-block mb-2">{{ node.name|badge(badgeClass) }}</span>
  21.         {% if node.messages is not empty %}
  22.             <ul class="list-group ms-4">
  23.                 {% for message in node.messages %}
  24.                     <li class="list-group-item">=> {{ message }}</li>
  25.                 {% endfor %}
  26.             </ul>
  27.         {% endif %}
  28.         {% if node.children is not empty %}
  29.             <ul class="list-group ms-4">
  30.                 {% for childPath, childNode in node.children %}
  31.                     {{ _self.renderTree(childNode, level + 1) }}
  32.                 {% endfor %}
  33.             </ul>
  34.         {% endif %}
  35.     </li>
  36. {% endmacro %}
  38. {% block body %}
  39.     <div class="card mb-12">
  40.         <div class="card-body flex-column px-5 py-3">
  41.             <div class="d-flex align-items-center h-lg-300px px-5 py-3 p-lg-15">
  42.                 <div class="row">
  43.                     <div class="col-md-8 pt-5 scroll-y">
  44.                         <h1 class="fw-bold fs-4 fs-lg-1 text-gray-800 mb-3">API errors responses</h1>
  45.                         <div class="position-relative w-100 text-gray-800">
  46.                             <p>Foxorder's API includes an error management system, this system allows users to have assistance in case of error.</p>
  47.                             <p>Depending on the type of errors, the error message is often explicit (typing, null, format, etc.) otherwise, it indicates the source of the error and possibly the solution.</p>
  48.                         </div>
  49.                     </div>
  50.                     <div class="col-md-4 text-center">
  51.                         <img alt="Logo" src="{{ asset( foxorders_doc ~ 'api-error.svg') }}" style="width:300px; height:auto">
  52.                     </div>
  53.                 </div>
  54.             </div>
  55.         </div>
  56.     </div>
  57.     <div class="card">
  58.         <div class="card-body">
  59.             <div class="table-responsive">
  60.                 <table class="table table-row-bordered table-row-dashed gy-4 align-middle fw-bold">
  61.                     <thead class="fs-7 text-gray-400 text-uppercase">
  62.                         <tr>
  63.                             <th class="min-w-250px">Endpoint</th>
  64.                             <th class="min-w-90px text-center">Method</th>
  65.                             <th class="min-w-250px text-center">Error code => message</th>
  66.                         </tr>
  67.                     </thead>
  68.                     <tbody class="fs-6 text-gray-800">
  69.                         {% for group in apis %}
  70.                             {% if section is null %}
  71.                                 <tr>
  72.                                     <td colspan="8" class="text-center bg-light-dark">
  73.                                         {{ group.group|upper }}
  74.                                     </td>
  75.                                 </tr>
  76.                             {% endif %}
  77.                             {% set authorized = 'app.documentation.badge.authorized'|trans|badge('light-success', false) %}
  78.                             {% set unauthorized = 'app.documentation.badge.unauthorized'|trans|badge('light-danger', false) %}
  79.                             {% for value in group.list %}
  80.                                 {% if value.errors is defined %}
  81.                                     <tr style="border-bottom: 1px solid #cccccc;">
  82.                                         <td><span class="mb-1 text-hover-primary">{{ value.api }}</span></td>
  83.                                         <td class="text-center">
  84.                                             {% set typeClass = {
  85.                                                 'POST': 'warning',
  86.                                                 'PUT': 'primary',
  87.                                                 'PATCH': 'info',
  88.                                                 'DELETE': 'danger'
  89.                                             }[value.type]|default('success') %}
  91.                                             {{ value.type|upper|badge('light-' ~ typeClass, false) }}
  92.                                         </td>
  93.                                         <td>
  94.                                             <ul class="list-group">
  95.                                             {% for err in value.errors %}
  96.                                                 <li class="list-group-item">
  97.                                                     <span class="text-hover-primary d-block">{{ err.code|badge('light-danger') }} => {{ err.message }}</span>
  98.                                                     {% if err.violations is defined %}
  99.                                                         <ul class="list-group mt-3">
  100.                                                             {% for nodePath, node in err.violations %}
  101.                                                                 {{ _self.renderTree(node, 0) }}
  102.                                                             {% endfor %}
  103.                                                         </ul>
  104.                                                     {% endif %}
  105.                                                 </li>
  106.                                             {% endfor %}
  107.                                             </ul>
  108.                                         </td>
  109.                                     </tr>
  110.                                 {% endif %}
  111.                             {% else %}
  112.                                 <tr>
  113.                                     <td colspan="8" style='color:orange'>{{ 'app.global.detail.no_record_found'|trans }}</td>
  114.                                 </tr>
  115.                             {% endfor %}
  117.                         {% else %}
  118.                             <tr>
  119.                                 <td colspan="8" style='color:orange'>{{ 'app.global.detail.no_record_found'|trans }}</td>
  120.                             </tr>
  121.                         {% endfor %}
  122.                     </tbody>
  123.                 </table>
  124.             </div>
  125.         </div>
  126.     </div>
  127. {% endblock %}