الإصدارات والتغييرات

الإصدار الحالي

العقد الحالي يحمل إصدار 1.0.0 ويستخدم OpenAPI 3.1. المسارات موجودة تحت Prefix يحدد حسب بيئة LuxPay. لا تبنِ العميل على إزالة prefix أو على نطاق Placeholder الموجود في الملف.

تغييرات متوافقة

إضافة حقل اختياري أو Endpoint جديد أو قيمة استجابة غير إلزامية تعد عادة متوافقة، لكن العميل يجب أن يتجاهل الحقول التي لا يعرفها. لا تستخدم مطابقة صارمة تمنع أي خاصية جديدة في JSON.

تغييرات غير متوافقة

إزالة حقل، تغيير نوعه، جعل حقل اختياري إلزاميًا، تغيير معنى الحالة، أو نقل مفتاح منع التكرار تعد تغييرات كاسرة. تحتاج إلى إصدار رئيسي أو فترة إهمال موثقة. يجب ألا يتغير سلوك مالي بصمت تحت الإصدار نفسه.

مراقبة الانحراف

يحتوي هذا المستودع على بوابة تتحقق من operationId والمسارات والمخططات والمراجع. عند تغيير LuxApi يجب تحديث OpenAPI والشرح والاختبارات في Pull Request واحد أو مترابط. لا تنشر مرجعًا أخضر بينما العقد الفعلي مختلف.

سياسة العميل

ثبّت الإصدار الرئيسي الذي تدعمه، وسجل operationId بدل ربط القياسات بنص URL فقط. راقب Changelog، واختبر Sandbox قبل ترقية Production. احتفظ بإمكانية Rollback لمكتبة العميل وإعدادات المزود.