API Documentation
This site is the narrative guide for frontend developers integrating with the API.
- Getting started — base URL, response envelope, authentication, localization.
- Lists, filtering & pagination — the single list-endpoint contract used across the API.
- Catalog — programmes and their terms, legal acts, FAQ, reception schedule, org chart.
- News — press articles and their categories, public reads and the editorial API.
- Assistant — the digital helper: how answers are produced and cited.
- Admin panel authentication — cookie-session login, logout and the permission-carrying profile the admin SPA uses.
- Audit log — the read-only login trail (both login endpoints): what's recorded, filters, sorts and permission.
- Dashboard — the admin panel's landing-page numbers: accounts, published stories, views, assistant sessions and the 6-month trend.
- Appeals — the electronic reception: submitting an appeal, checking its status with a tracking number and access code, and the staff review flow.
- Search — one call across legal acts, programmes, FAQ and news; how terms are matched in both Uzbek scripts.
- API Reference — every endpoint, generated from the OpenAPI spec.
The exhaustive auto-generated reference (request/response examples, Postman collection) also lives at /guide (Scribe).
Keeping these docs current
The markdown pages here are hand-written and live in docs/guides/. Whenever an endpoint, Form Request, resource or filter changes, update the matching page in the same change. The OpenAPI spec is regenerated with:
bash
php artisan scribe:generate
php artisan docs:sync-openapi
docs/guides/openapi.yaml is committed — Scribe is a dev-only dependency, so the spec must ride git into production.