Gateway

عقد خطة تطبيق الأسرار

تحدد هذه الصفحة العقد الصارم الذي يفرضه OmeniaClaw secrets apply.

إذا لم يطابق هدف ما هذه القواعد، يفشل التطبيق قبل تعديل الإعدادات.

شكل ملف الخطة

يتوقع OmeniaClaw secrets apply --from <plan.json> مصفوفة targets من أهداف الخطة:

json5
{  version: 1,  protocolVersion: 1,  targets: [    {      type: "models.providers.apiKey",      path: "models.providers.openai.apiKey",      pathSegments: ["models", "providers", "openai", "apiKey"],      providerId: "openai",      ref: { source: "env", provider: "default", id: "OPENAI_API_KEY" },    },    {      type: "auth-profiles.api_key.key",      path: "profiles.openai:default.key",      pathSegments: ["profiles", "openai:default", "key"],      agentId: "main",      ref: { source: "env", provider: "default", id: "OPENAI_API_KEY" },    },  ],}

نطاق الهدف المدعوم

تُقبل أهداف الخطة لمسارات بيانات الاعتماد المدعومة في:

سلوك نوع الهدف

القاعدة العامة:

  • يجب أن يكون target.type معروفًا ويجب أن يطابق شكل target.path المُطبَّع.

لا تزال الأسماء المستعارة المتوافقة مقبولة للخطط الحالية:

  • models.providers.apiKey
  • skills.entries.apiKey
  • channels.googlechat.serviceAccount

قواعد التحقق من المسار

يتم التحقق من كل هدف وفق جميع ما يلي:

  • يجب أن يكون type نوع هدف معروفًا.
  • يجب أن يكون path مسارًا نقطيًا غير فارغ.
  • يمكن حذف pathSegments. وإذا تم توفيره، فيجب أن يُطبَّع إلى المسار نفسه تمامًا مثل path.
  • تُرفض المقاطع المحظورة: __proto__ وprototype وconstructor.
  • يجب أن يطابق المسار المُطبَّع شكل المسار المسجَّل لنوع الهدف.
  • إذا تم ضبط providerId أو accountId، فيجب أن يطابق المعرّف المُشفَّر في المسار.
  • تتطلب أهداف auth-profiles.json وجود agentId.
  • عند إنشاء ربط جديد في auth-profiles.json، ضمّن authProfileProvider.

سلوك الفشل

إذا فشل هدف في التحقق، يخرج التطبيق بخطأ مثل:

text
Invalid plan target path for models.providers.apiKey: models.providers.openai.baseUrl

لا يتم تثبيت أي عمليات كتابة لخطة غير صالحة.

سلوك الموافقة على موفر exec

  • يتخطى --dry-run فحوصات SecretRef من نوع exec افتراضيًا.
  • تُرفض الخطط التي تحتوي على SecretRefs/providers من نوع exec في وضع الكتابة ما لم يتم ضبط --allow-exec.
  • عند التحقق من خطط تحتوي على exec أو تطبيقها، مرّر --allow-exec في كل من أوامر التنفيذ التجريبي وأوامر الكتابة.

ملاحظات حول نطاق وقت التشغيل والتدقيق

  • تُضمَّن إدخالات auth-profiles.json التي تحتوي على مراجع فقط (keyRef/tokenRef) في حلّ وقت التشغيل وفي تغطية التدقيق.
  • يكتب secrets apply أهداف OmeniaClaw.json المدعومة، وأهداف auth-profiles.json المدعومة، وأهداف التنظيف الاختيارية.

فحوصات المشغّل

bash
# Validate plan without writesOmeniaClaw secrets apply --from /tmp/OmeniaClaw-secrets-plan.json --dry-run # Then apply for realOmeniaClaw secrets apply --from /tmp/OmeniaClaw-secrets-plan.json # For exec-containing plans, opt in explicitly in both modesOmeniaClaw secrets apply --from /tmp/OmeniaClaw-secrets-plan.json --dry-run --allow-execOmeniaClaw secrets apply --from /tmp/OmeniaClaw-secrets-plan.json --allow-exec

إذا فشل التطبيق برسالة مسار هدف غير صالح، فأعد إنشاء الخطة باستخدام OmeniaClaw secrets configure أو أصلح مسار الهدف إلى شكل مدعوم كما هو موضح أعلاه.

وثائق ذات صلة

Was this useful?
On this page

On this page