Files

T

hamedandClaude Opus 5 24534ec483 feat(availability): multi-resource availability engine

Section 10 of the design document, and the payoff for tasks 01–05. The engine slides
a multi-segment plan across resource calendars and answers which times are actually
possible, with a suggested resource for each role. Until now the only conflict the
system checked was the doctor's; rooms, devices and operators did not exist.

Allocation is per *role*, not per segment, and that is what returns the wasted
capacity. An operator with no requirement during "waiting for the cream" is simply
not examined for those minutes, so another patient can use them. The reference test
encodes exactly that: patient A holds 10:00–11:00 while the operator is only busy
10:00–10:05 and 10:35–11:00, and patient B is offered a slot inside the gap with the
second room assigned. The spec says the task is not verified without that scenario.

One resource is chosen for every segment that needs its role, not independently per
segment — otherwise the operator in segment 1 and segment 3 could be two different
people and the patient would change hands mid-treatment.

Occupancy is stored one row per (segment × resource) rather than one per appointment.
The granularity is the whole point; a row per appointment would re-create the
single-interval model the design rejects. Reserved intervals are widened by each
resource's setup/cleanup, because the resource genuinely is not available then.

booking_mode gains a third value, resource, alongside slot and service. It is purely
additive: the default stays slot, no environment moves on its own, and a location
that has not opted in keeps the untouched legacy path. The frozen slot-mode contract
stays green.

Performance is a test, not a hope: 30 days, 20 resources and 500 existing bookings
complete well inside the 500ms budget. Every input is read once and the rest is in
memory — no query inside the day or candidate loop — and candidates are generated
only from the free windows of the scarcest role, which turns tens of thousands of
candidates into a few hundred.

An empty result is not an error and not a 404: it carries
reason: "no_capacity_in_range" so the caller does not have to infer meaning from
emptiness.

Also fixed a genuinely intermittent test defect: NumericFieldNormalizerTest padded a
random number with the three-byte Persian "۰" using byte-based str_pad, producing
broken UTF-8 whenever the number was short. It failed roughly at random. The improved
assertion message added earlier is what identified it immediately.

1196 tests / 3414 assertions. phpstan at its 14-error baseline.

Resource-picking strategies, the availability cache and the settings UI are recorded
as outstanding in the checklist with reasons — the cache in particular would be
premature while the performance test passes comfortably without it.

Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>

2026-07-30 21:21:33 +03:30

6.0 KiB

Raw Blame History

ClinicPro — API Documentation Index

Base URL: https://clinic-pro.ddev.site
API Prefix: /api/v1
Swagger UI: https://clinic-pro.ddev.site/api/doc — user: admin / pass: clinic123

Authentication

All protected endpoints require:

Authorization: Bearer <JWT_TOKEN>

Role	Description
`PUBLIC`	No token required
`AUTH`	Any valid JWT
`ROLE_ADMIN`	Admin user
`ROLE_DOCTOR`	Doctor user
`ROLE_CLINIC`	Clinic owner
`ROLE_SECRETARY`	Secretary

Standard Response Envelope

// Success
{ "success": true, "data": { ... } }

// Paginated
{ "success": true, "data": [...], "meta": { "totalRecords": 100, "totalPages": 5, "currentPage": 1, "limit": 20 } }

// Error
{ "success": false, "data": null, "errors": [{ "code": "ERR_XXX_000", "message": "..." }] }

meta.limit اندازهٔ صفحهٔ واقعاً اعمال‌شده است. ریپازیتوری‌ها limit درخواستی را به سقف خودشان کاهش می‌دهند (مثلاً لیست پزشکان: سقف ۵۰)، پس برای پیمایش کامل به meta.totalPages تکیه کن — نه به این فرض که «تعداد آیتم کمتر از limit درخواستی یعنی صفحهٔ آخر».

Persian digit normalization (global)

Persian (۰-۹) and Arabic (٠-٩) digits sent in numeric request fields are translated to Latin server-side, before the controller runs — src/Shared/EventSubscriber/NumericFieldNormalizerSubscriber.php. Every client benefits: the React admin panel, nobat724_front, and clinic-pro-tauri.

Applies to POST / PUT / PATCH requests under /api/v1/ with a JSON body, recursively through nested arrays.

Normalized keys:

mobile, mobile_number, telephone, phone, notification_mobile,
national_code, postal_code,
card_number, account_number, sheba, shaba, iban,
price_rials, amount_rials, amount, free_visit_price_rials,
insurance_price_rials, patient_share_rials, visit_price_rials,
duration_minutes, duration, commission_percent, coverage,
coverage_percent, franchise, ceiling, tax_percent,
base_insurance_discount_percent, supplementary_discount_percent

Only digits are translated — no characters are stripped, so IR in a sheba and - in a landline survive. Non-string values (int, bool, null) and keys outside the list are untouched, so a name like منشی شماره ۲ keeps its Persian digit.

// request
{ "mobile_number": "۰۹۱۲۳۴۵۶۷۸۹", "national_code": "۰۰۱۲۳۴۵۶۷۸", "name": "منشی شماره ۲" }

// what the controller sees
{ "mobile_number": "09123456789", "national_code": "0012345678", "name": "منشی شماره ۲" }

Adding a new numeric field to any endpoint? Add its key to NUMERIC_KEYS in the subscriber, otherwise Persian digits reach the database.

Modules

File	Domain	Endpoints
auth.md	Authentication — OTP, Login, JWT	8
doctor.md	Doctor profile & addresses	11
clinic.md	Clinics	7
clinic-invitation.md	Doctor invitations to clinics	8
branch.md	Branches (= addresses), working hours, rooms	8
resource.md	Resources, types, skills, pools	16
resource-calendar.md	Resource calendars, exceptions, national holidays	9
appointment-plan.md	Appointment segments and plan preview	3
appointment-availability.md	Multi-resource availability search	2
appointment.md	Appointments & slot booking	6
appointment-settings.md	Weekly schedule, date overrides, holidays	14
payment.md	Payments (Mellat / Sep)	5
settlement.md	Wallet & settlement requests	7
rating.md	Ratings, comments, likes	9
secretary.md	Doctor secretaries	5
representation.md	Representations (agents)	6
sms.md	SMS send & templates	10
blog.md	Blog posts	6
specialty.md	Medical specialties	5
insurance.md	Insurances & doctor-insurance links	10
doctor-service.md	Doctor services	5
tag.md	Blog tags	5
location.md	Provinces & cities	10
user-profile.md	User medical profile	4
admin.md	Admin dashboard & management	25+

Error Code Reference

Code	Message (FA)	HTTP
`ERR_AUTH_001`	توکن JWT منقضی یا نامعتبر	401
`ERR_AUTH_002`	کد OTP نامعتبر	401
`ERR_AUTH_003`	کد OTP منقضی شده	401
`ERR_AUTH_004`	تعداد تلاش‌های OTP به حد مجاز رسیده	429
`ERR_AUTH_005`	نام کاربری یا رمز عبور اشتباه	401
`ERR_AUTH_006`	دسترسی ممنوع	403
`ERR_VALIDATION_001`	ورودی نامعتبر	422
`ERR_VALIDATION_002`	فیلد الزامی وارد نشده	422
`ERR_NOT_FOUND_001`	منبع درخواستی یافت نشد	404
`ERR_CONFLICT_001`	تداخل: منبع در حال استفاده	409
`ERR_FORBIDDEN_001`	دسترسی به این منبع مجاز نیست	403
`ERR_PAYMENT_001`	درگاه پرداخت در دسترس نیست	503
`ERR_PAYMENT_002`	مبلغ پرداخت نامعتبر	422
`ERR_PAYMENT_003`	وضعیت نوبت برای پرداخت مناسب نیست	422
`ERR_FILE_001`	فرمت فایل مجاز نیست	422
`ERR_SMS_003`	تمپلیت قبلاً ارسال شده	422
`ERR_SECRETARY_001`	پلن فعلی اجازه منشی بیشتر نمی‌دهد	422
`ERR_RATE_LIMIT_001`	درخواست‌های زیاد، بعداً تلاش کنید	429

6.0 KiB Raw Blame History Unescape Escape