مرجع نقاط نهاية API v1
تُفحص هذه المصفوفة مقابل عقد OpenAPI الرسمي في وقار وسجل النطاقات. المسارات
أدناه نسبية إلى https://waqar.app/api/v1.
| الطريقة | المسار | النطاق المطلوب |
|---|---|---|
| GET | /school | school:read |
| GET | /semesters | semesters:read |
| GET | /semesters/{id} | semesters:read |
| GET | /halqas | halqas:read |
| GET | /halqas/{id} | halqas:read |
| GET | /sheikhs | sheikhs:read |
| GET | /sheikhs/{id} | sheikhs:read |
| GET | /students | students:read |
| POST | /students | students:write |
| GET | /students/{id} | students:read |
| PATCH | /students/{id} | students:write |
| GET | /students/{id}/recitations | recitations:read |
| GET | /learning-plans | learning_plans:read |
| GET | /learning-plans/{id} | learning_plans:read |
| GET | /learning-plans/{id}/assignments | learning_plans:read |
| GET | /sessions | sessions:read |
| POST | /sessions | sessions:write |
| GET | /sessions/{id} | sessions:read |
| PATCH | /sessions/{id} | sessions:write |
| POST | /sessions/{id}/end | sessions:write |
| GET | /sessions/{id}/attendance | attendance:read |
| PUT | /sessions/{id}/attendance | attendance:write |
| GET | /sessions/{id}/recitations | recitations:read |
| POST | /sessions/{id}/recitations | recitations:write |
| GET | /surahs | authenticated |
| GET | /surahs/{number} | authenticated |
تعني authenticated أن العملية تتطلب مفتاح API صحيحاً، ولا يرتبط بها نطاق
مورد إضافي.
قواعد العقد
Section titled “قواعد العقد”- احصل على العقد الآلي الحالي من
/api/openapi.yaml. - استخدم
/api/docsللمخططات والمعاملات والتعدادات والأمثلة وحالات الاستجابة المعروضة. - لا تستنتج طريقة غائبة عن هذه المصفوفة.
- لا ترسل إلا المرشحات المسردة للعملية المختارة.
- استخدم دليل الموارد للمعاني ومخطط OpenAPI للحقول الدقيقة.
- عامل المسارات والنطاقات وقيم التعداد ورموز الخطأ الثابتة كمعرّفات آلية محايدة اللغة.