في هذه الصفحة
نظرة سريعة#
يعرف العميل أن العملية في طريقها إلى الزوال من التعريف ومن الاستجابة نفسها. يعلّم التعريف العملية بـ deprecated: true؛ وتوثّق كل استجابة نجاح لتلك العملية ترويستين.
| الترويسة | المعيار | القيمة | مثال |
|---|---|---|---|
Deprecation | RFC 9745 | لحظة إيقاف العملية، كطابع زمني Unix تسبقه @ | Deprecation: @1792368000 |
Sunset | RFC 8594 | لحظة توقف العملية عن الإجابة، كتاريخ HTTP | Sunset: Tue, 19 Jan 2027 00:00:00 GMT |
Link | RFC 8288 | اختيارية: البديل، مع rel="successor-version" | Link: </v3/orders>; rel="successor-version" |
HTTP/1.1 200 OK Deprecation: @1792368000 Sunset: Tue, 19 Jan 2027 00:00:00 GMT Link: </v3/orders>; rel="successor-version" Content-Type: application/json
في التعريف#
/orders/legacy:
get:
operationId: legacyOrders
deprecated: true
description: Replaced by the orders list of v3.
responses:
"200":
description: Orders.
headers:
Deprecation:
description: When this operation was deprecated.
schema: { type: string }
Sunset:
description: When this operation stops answering.
schema: { type: string }اذكر في description ما يحلّ محل العملية. ولا تسبق لحظة Sunset أبداً نهاية مدة الإشعار في قواعد الإصدارات.
تضيف البوابة ترويستي Deprecation وSunset إلى كل استجابة من إصدار رئيسي موقوف، وتبقى المسارات قائمة حتى تاريخ الإيقاف النهائي.
تتحقق منه#
| القاعدة | الشدة | ما تتحقق منه |
|---|---|---|
api360-deprecation-headers | error | تُوثّق العملية ذات deprecated: true الترويستين Deprecation وSunset على كل استجابة 2xx (أسماء الترويسات غير حساسة لحالة الأحرف) |
انظر أيضاً#
- الإصدارات: متى يلزم إصدار رئيسي جديد.
- إنشاء إصدار وإيقاف إصدار: ما يراه المشتركون اليوم.