templates/Doc/access.html.twig line 1

Open in your IDE?
  1. {% extends 'Layouts/Doc/default.html.twig' %}
  3. {% block title %}Documentation
  4. {% endblock %}
  5. {% block headerPageTitle %}
  6.     {{ 'app.documentation.page.title.index'|trans |upper}}
  7. {% endblock %}
  9. {% block body %}
  10.     <div class="card mb-12">
  11.         <div class="card-body flex-column p-5">
  12.             <div class="d-flex align-items-center h-lg-300px p-5 p-lg-15">
  13.                 <div class="row">
  14.                     <div class="col-md-8 pt-5 scroll-y">
  15.                         <h1 class="fw-bold fs-4 fs-lg-1 text-gray-800 mb-3">API Access per scope</h1>
  16.                         <div class="position-relative w-100 text-gray-800">
  17.                             <p>Foxorder's API contains diffrents roles. Each endpoint is restricted for one or multiple roles depending on its need.</p>
  18.                             <p>If you would like to test these endpoints
  19.                                 <a href="{{ path('foxorders_api_doc') }}" target="_blank">in our Swagger UI docs</a>, you need to retrieve a JWT token first.</p>
  20.                             <p>Here are the roles available in our API:</p>
  21.                             <div class="list-group text-active-gray-800">
  22.                                 <span class="list-group-item list-group-item-action flex-column align-items-start">
  23.                                     <div class="d-flex w-100 justify-content-between">
  24.                                         <span class="fw-bold">SCOPE MANAGER</span>The manager of the franchise
  25.                                     </div>
  27.                                 </span>
  28.                                 <span class="list-group-item list-group-item-action flex-column align-items-start">
  29.                                     <div class="d-flex w-100 justify-content-between">
  30.                                         <span class="fw-bold">SCOPE SHOP_OWNER</span>The manager of the shop
  31.                                     </div>
  32.                                 </span>
  33.                                 <span class="list-group-item list-group-item-action flex-column align-items-start">
  34.                                     <div class="d-flex w-100 justify-content-between">
  35.                                         <span class="fw-bold">SCOPE FRONT</span>Franchise's online shop
  36.                                     </div>
  37.                                 </span>
  38.                                 <span class="list-group-item list-group-item-action flex-column align-items-start">
  39.                                     <div class="d-flex w-100 justify-content-between">
  40.                                         <span class="fw-bold">SCOPE CUSTOMER</span>The customer
  41.                                     </div>
  42.                                 </span>
  43.                             </div>
  44.                         </div>
  45.                     </div>
  46.                     <div class="col-md-4 text-center">
  47.                         <img alt="Logo" src="{{ asset( foxorders_doc ~ 'api-photo-page.jpg') }}" style="width:300px; height:auto">
  48.                     </div>
  49.                 </div>
  50.             </div>
  51.         </div>
  52.     </div>
  53.     <div class="card">
  54.         <div class="card-body">
  55.             <div class="table-responsive">
  56.                 <table class="table table-row-bordered table-row-dashed gy-4 align-middle fw-bold">
  57.                     <thead class="fs-7 text-gray-400 text-uppercase">
  58.                         <tr>
  59.                             <th class="min-w-250px">Endpoint</th>
  60.                             <th class="min-w-90px text-center">Method</th>
  61.                             <th class="min-w-250px">Description</th>
  62.                             <th class="min-w-90px text-center">FRONT</th>
  63.                             <th class="min-w-90px text-center">MANAGER</th>
  64.                             <th class="min-w-90px text-center">SHOP_OWNER</th>
  65.                             <th class="min-w-90px text-center">CUSTOMER</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.                                 <tr>
  81.                                     <td>
  82.                                         <span class="mb-1 text-hover-primary">{{ value.api }}</span>
  83.                                     </td>
  84.                                     <td class="text-center">
  85.                                         {% if 'POST' == value.type %}
  86.                                             {% set typeClass = 'warning' %}
  87.                                         {% elseif 'PUT' == value.type %}
  88.                                             {% set typeClass = 'primary' %}
  89.                                         {% elseif 'PATCH' == value.type %}
  90.                                             {% set typeClass = 'info' %}
  91.                                         {% elseif 'DELETE' == value.type %}
  92.                                             {% set typeClass = 'danger' %}
  93.                                         {% else %}
  94.                                             {% set typeClass = 'success' %}
  95.                                         {% endif %}
  96.                                         {{ value.type|upper|badge('light-' ~ typeClass, false) }}
  97.                                     </td>
  98.                                     <td>
  99.                                         <span class="mb-1 text-hover-primary">{{ value.description|raw }}</span>
  100.                                     </td>
  101.                                     <td class="text-center">
  102.                                         {{ (value.api_role  ? authorized : unauthorized)|raw }}
  103.                                     </td>
  104.                                     <td class="text-center">
  105.                                         {{ (value.manager  ? authorized : unauthorized)|raw }}
  106.                                     </td>
  107.                                     <td class="text-center">
  108.                                         {{ (value.shop_owner  ? authorized : unauthorized)|raw }}
  109.                                     </td>
  110.                                     <td class="text-center">
  111.                                         {{ (value.customer  ? authorized : unauthorized)|raw }}
  112.                                     </td>
  113.                                 </tr>
  114.                             {% else %}
  115.                                 <tr>
  116.                                     <td colspan="8" style='color:orange'>{{ 'app.global.detail.no_record_found'|trans }}</td>
  117.                                 </tr>
  118.                             {% endfor %}
  120.                         {% else %}
  121.                             <tr>
  122.                                 <td colspan="8" style='color:orange'>{{ 'app.global.detail.no_record_found'|trans }}</td>
  123.                             </tr>
  124.                         {% endfor %}
  125.                     </tbody>
  126.                 </table>
  127.             </div>
  128.         </div>
  129.     </div>
  130. {% endblock %}