OpenAPI

השער מגיש מסמך OpenAPI 3.1 בכתובת:

GET https://api.rolchat.com/openapi.json

הוא מורכב בעת עליית השער מהמסמכים שכל שירות תורם: נתיבים וסכמות ממוזגים, כפילויות מקבלות מרחב שמות לפי שירות, וכל נתיב שמסומן כפנימי (לרשת הפנימית בלבד) מוסר. התרומות מתווספות שירות אחר שירות; משפחות שעוד לא תרמו מופיעות בתיעוד נקודות הקצה אבל לא במסמך. עד שהמסמך יכסה את כל הממשק, התייחסו לתיעוד נקודות הקצה כרשימה המחייבת של המשפחות ולעמוד המוסכמות כחוזה המחייב.

כל חוזה של RolChat, במסמך או מחוצה לו, עוקב אחר המוסכמות: המעטפת, עימוד באמצעות סמן, מפתחות אידמפוטנטיות, כותרות מגבלת קצב וקודי השגיאה.