Словарь терминов

API

API (Application Programming Interface) — программный интерфейс приложения. Набор правил и протоколов, определяющих способ взаимодействия между программными компонентами. В tevas.io контракты описывают API объектов: эндпоинты, методы, пути и тела запросов.

Организация

Верхнеуровневая единица в tevas.io. Объединяет команды, системы и пользователей. Каждый пользователь может состоять в нескольких организациях и переключаться между ними.

Команда

Группа пользователей внутри организации. Команде назначаются системы, а участникам команды — роли (наблюдатель, редактор, администратор, владелец).

Система

Отдельная архитектурная диаграмма внутри команды. Содержит объекты и связи, которые описывают структуру вашей системы. Системы можно группировать с помощью папок.

Папка

Структура для группировки систем внутри команды. Папки могут быть вложенными. Используются для логического разделения работы (например, по продуктам или направлениям).

Доска

Рабочая область для построения диаграммы. Содержит объекты, связи между ними и панель инструментов.

Объект

Элемент архитектурной диаграммы. Может быть одного из шести типов:

• Сервис — API-сервис (REST, gRPC, GraphQL и др.)
• База данных — хранилище данных (PostgreSQL, MongoDB, Redis и др.)
• Очередь сообщений — брокер сообщений (Kafka, RabbitMQ, NATS и др.)
• Пользователь — внешний пользователь или актор
• Группа — контейнер для группировки объектов
• Рамка — визуальная граница для выделения области на диаграмме

Связь

Соединение между двумя объектами на диаграмме. Показывает направление взаимодействия и используемый протокол. Может быть однонаправленной или двунаправленной.

Протокол

Способ взаимодействия между объектами. Протоколы группируются по типу объекта:

• Сервис — REST, gRPC, GraphQL, SOAP, WebSocket
• Очередь — Kafka, AMQP, MQTT, Pulsar, NATS
• База данных — PostgreSQL, MySQL, MongoDB, Redis

Контракт

Описание API объекта: эндпоинты, методы, пути, тело запроса. Контракты можно создавать вручную или импортировать из спецификаций (OpenAPI, Protobuf, GraphQL, WSDL, AsyncAPI).

Обсуждение

Тема для обсуждения, привязанная к конкретному объекту или системе. Содержит комментарии участников, поддерживает @-упоминания. Обсуждение можно отметить как решённое.

Уведомление

Сообщение о событии: упоминание в обсуждении, приглашение в команду, ответ на комментарий. Уведомления приходят в реальном времени.

Тег

Метка для категоризации объектов. Теги организованы в иерархическую структуру (дерево) и принадлежат организации.

Технология

Элемент стека технологий, который можно назначить объекту. Технологии организованы в иерархическую структуру с поддержкой иконок и принадлежат организации.

Пользователь

Зарегистрированный участник платформы tevas.io. Принадлежит одной или нескольким организациям, может быть участником команд с различными ролями.

Не путать с типом объекта «Пользователь» на диаграмме — он обозначает внешнего актора в архитектуре (конечный пользователь продукта, внешняя система и т.д.).

Тариф

Тарифный план, определяющий доступные возможности и ограничения. В tevas.io доступны тарифы: Бесплатный, Бизнес, Корпоративный. Подробнее см. Тарифы.

Роль

Набор прав доступа, назначаемый пользователю. В tevas.io существуют три уровня ролей:

• Системные роли — определяют общий уровень доступа к платформе
• Роли в организации — владелец или участник
• Роли в команде — наблюдатель, редактор, администратор, владелец

Подробнее см. Ролевая модель.

Приглашение

Механизм добавления пользователя в команду. Отправляется на email, содержит одноразовый токен. Приглашение можно принять или отклонить.

Импорт

Загрузка контрактов из внешних спецификаций. Поддерживается 12 форматов для сервисов, очередей и баз данных: OpenAPI, Protobuf, GraphQL, WSDL, AsyncAPI, SQL DDL, Prisma, JSON Schema, Avro, DBML, Redis Schema и др. Подробнее см. Объекты — Контракты и импорт.

Экспорт

Выгрузка системы с анонимизированными идентификаторами для переноса между командами или организациями.