مخططات البيانات: النماذج المشتركة

codeسلسلة نصيةمطلوب

رمز ثابت قابل للقراءة آليًا.

القيود

enum

["request.malformed", "authentication.required", "authentication.invalid_credentials", "authorization.scope_denied", "authorization.ip_not_allowed", "authorization.client_ip_unverified", "entitlements.api_disabled", "entitlements.operation_disabled", "entitlements.limit_exceeded", "entitlements.resource_blocked", "resource.not_found", "request.method_not_allowed", "resource.version_conflict", "resource.state_conflict", "resource.in_use", "resource.already_exists", "idempotency.key_reused", "request.too_large", "request.unsupported_media_type", "request.validation_failed", "rate_limit.exceeded", "capacity.queue_full", "capacity.wait_timeout", "internal.error", "gateway.bad_response", "service.unavailable", "gateway.timeout"]

مثال: "authentication.invalid_credentials"

fieldsمصفوفة <FieldError > | nullاختياري

أخطاء التحقق الخاصة بكل حقل.

مثال: null

messageسلسلة نصيةمطلوب

شرح موجه للمستخدم؛ استخدم رمز الخطأ في منطق البرنامج.

مثال: "The credentials are invalid."

حقول إضافية: لا

dataMutationData مطلوب

مثال على الاستجابة · MutationData.

مثال: {"deleted":false,"id":"example","version":1}

metaContextPageMeta | ContextMeta | PageMeta | RequestMeta مطلوب

البيانات الوصفية للاستجابة.

مثال: {"request_id":"example"}

حقول إضافية: لا

localeسلسلة نصيةمطلوب

اللغة المحددة لهذا الطلب.

مثال: "en"

market_codeسلسلة نصيةمطلوب

رمز السوق الذي تعيده نقطة نهاية السياق.

مثال: "PL"

market_idسلسلة نصيةمطلوب

معرّف السوق الذي تعيده نقطة نهاية السياق.

مثال: "example"

request_idسلسلة نصيةمطلوب

معرّف الطلب؛ في البيانات الوصفية للاستجابة يحدد طلب HTTP.

minLength: 1maxLength: 100

مثال: "example"

حقول إضافية: لا

localeسلسلة نصيةمطلوب

اللغة المحددة لهذا الطلب.

مثال: "en"

market_codeسلسلة نصيةمطلوب

رمز السوق الذي تعيده نقطة نهاية السياق.

مثال: "PL"

market_idسلسلة نصيةمطلوب

معرّف السوق الذي تعيده نقطة نهاية السياق.

مثال: "example"

paginationPagination مطلوب

البيانات الوصفية للترقيم باستخدام المؤشر.

مثال: {"has_more":false,"limit":20,"next_cursor":null}

request_idسلسلة نصيةمطلوب

معرّف الطلب؛ في البيانات الوصفية للاستجابة يحدد طلب HTTP.

minLength: 1maxLength: 100

مثال: "example"

حقول إضافية: لا

errorApiError مطلوب

معلومات الخطأ المنظمة.

مثال: {"code":"authentication.invalid_credentials","fields":null,"message":"The credentials are invalid."}

metaRequestMeta مطلوب

البيانات الوصفية للاستجابة.

مثال: {"request_id":"example-request"}

حقول إضافية: لا

codeسلسلة نصيةمطلوب

رمز ثابت قابل للقراءة آليًا.

القيود

enum

["required", "invalid_type", "invalid_value", "out_of_range", "unknown_field", "invalid_format", "invalid_cursor", "unsupported_value"]

fieldسلسلة نصيةمطلوب

الحقل المرتبط بخطأ التحقق.

minLength: 1maxLength: 128

locationسلسلة نصيةمطلوب

معلومات الموقع.

القيود

enum

["path", "query", "header", "body"]

حقول إضافية: لا

amountسلسلة نصيةمطلوب

مبلغ عشري ممثل كسلسلة JSON؛ يسمح بالقيمة null فقط حيث يكون ذلك مسموحًا.

مثال: "0.00"

currencyسلسلة نصيةمطلوب

رمز عملة المبلغ.

القيود

pattern

"^[A-Z]{3}$"

مثال: "PLN"

minor_unitsعدد صحيحمطلوب

عدد المنازل العشرية التي تستخدمها العملة.

minimum: 0maximum: 4

مثال: 2

حقول إضافية: لا

deletedقيمة منطقيةمطلوب

ما إذا تم تنفيذ الحذف.

مثال: false

idسلسلة نصيةمطلوب

معرّف المورد؛ احتفظ به كما أعيد. (MutationData).

مثال: "example"

versionعدد صحيح | nullمطلوب

إصدار المورد المستخدم للتحكم في التعديلات المتزامنة.

مثال: 1

حقول إضافية: لا

paginationPagination مطلوب

البيانات الوصفية للترقيم باستخدام المؤشر.

مثال: {"has_more":false,"limit":20,"next_cursor":null}

request_idسلسلة نصيةمطلوب

معرّف الطلب؛ في البيانات الوصفية للاستجابة يحدد طلب HTTP.

minLength: 1maxLength: 100

مثال: "example"

حقول إضافية: لا

has_moreقيمة منطقيةمطلوب

ما إذا كانت هناك صفحة أخرى متاحة.

مثال: false

limitعدد صحيحمطلوب

العدد الأقصى للسجلات في هذه الصفحة.

minimum: 1maximum: 100

مثال: 20

next_cursorسلسلة نصية | nullمطلوب

قيمة المتابعة للصفحة التالية، أو null.

مثال: null

حقول إضافية: لا

request_idسلسلة نصيةمطلوب

معرّف الطلب؛ في البيانات الوصفية للاستجابة يحدد طلب HTTP.

minLength: 1maxLength: 100

مثال: "example"

حقول إضافية: لا