API کے صارفین اور مطابقت
VoiceStudio کے کون سے انٹرفیس عوامی، صرف براؤزر کے لیے، اور کون سے کبھی صارفین کے لیے نہیں ہیں۔
کنٹرول پلین کا ہر آپریشن ایک صارف گروہ سے متعلق ہے۔ مشترکہ OpenAPI ذریعہ کسی آپریشن کو عوامی نہیں بناتا۔
| صارف گروہ | راستے | کون کال کرتا ہے | یہاں شائع؟ |
|---|---|---|---|
| عوامی ڈویلپر API | /v1/* | محدود دائرے کی ڈویلپر اسناد | ہاں، Cloud پروجیکشن میں |
| ویب سائٹ ایج API | جانچا گیا گمنام /v1/marketing/* | سائٹ کے اپنے فارم | نہیں |
| ڈیش بورڈ/BFF API | /dashboard/v1/* | یکساں اصل سیشن والا ڈیش بورڈ | نہیں |
| آپریٹر API | جانچا گیا /internal/v1/* | پلیٹ فارم آپریٹرز | نہیں |
| اندرونی سروس API | دیگر /internal/v1/* | نجی سروسز | نہیں |
ویب سائٹ ایج، آپریٹر اور اندرونی راستے کبھی صارف API کا حصہ نہیں ہیں۔ یہ اور صرف ان کے استعمال والے اسکیما /cloud-openapi.json میں موجود نہیں۔ براؤزر کو کبھی ڈویلپر اسناد نہیں ملتیں اور عوامی کلائنٹ ڈیش بورڈ سیشن کوکی استعمال نہیں کرتے۔
مطابقت
مختلف مصنوعات کے درمیان مطابقت کا کوئی ذیلی مجموعہ جاری نہیں ہوا۔ مقامی 0.5.0 اور Cloud پیش نظارہ 1.0.0 دونوں معاہدوں میں POST /v1/audio/transcriptions ہے، مگر فیلڈز، تصدیق، Artifact اور Job کا رویہ، ٹائم آؤٹ اور خرابیاں باہم قابل تبادلہ قرار نہیں دی گئیں۔ اس کے لیے متعین ورژن جوڑے پر #71 کے رویے کے ٹیسٹ پاس ہونا ضروری ہے۔ تب تک مشترکہ راستے کا نام محض مماثلت ہے، مطابقت نہیں۔
Cloud جاری کرنا
OpenAPI دستاویز یا قابل عمل مثالوں میں فعال Cloud سرور شائع کرنا ریلیز کا مرحلہ ہے۔ ترتیب سے یہ ضروری ہیں:
- تصدیق شدہ پروڈکشن DNS اور TLS۔
- تصدیق، عوامی روٹنگ اور صارف کے لیے محفوظ ناکامیوں کے ابتدائی ٹیسٹ۔
- عین ورژنز کے لیے #71 مطابقت اور رول بیک کی جانچ۔
- دوبارہ تیار کردہ پروجیکشن جس میں
unavailableنہ ہو۔
رول بیک فعال سرور ہٹا دیتا ہے۔ پائیدار Jobs، Artifacts اور idempotency ریکارڈ برقرار رہتے ہیں۔