Skip to main content

Обновление сущности (Entity Update API)

Этот API позволяет обновлять данные существующей организации (entity) на платформе Ring. Можно изменить название, описание, сайт, теги, видимость и другие поля.

Эндпоинт​

PATCH /api/entities/update/[id]

  • id — уникальный идентификатор сущности (entity)
  • Аутентификация: требуется (JWT токен)
  • Роли: MEMBER, CONFIDENTIAL, ADMIN

Тело запроса (Request Body)​

Передавайте только те поля, которые нужно обновить:

{
  "name": "Новое название компании",
  "description": "Обновлённое описание",
  "website": "https://newsite.com",
  "tags": ["обновлено", "технологии"]
}

Ответ (Response)​

Успех (200 OK):

{
  "message": "Сущность успешно обновлена"
}

Возможные ошибки:

  • 400 — Некорректный формат или неверные данные
  • 401 — Неавторизован
  • 403 — Недостаточно прав
  • 404 — Сущность не найдена
  • 500 — Внутренняя ошибка сервера

Пример кода (TypeScript)​

async function updateEntity(id: string, updates: Partial<Entity>) {
  const response = await fetch(`/api/entities/update/${id}`, {
    method: 'PATCH',
    headers: {
      'Authorization': `Bearer ${token}`,
      'Content-Type': 'application/json'
    },
    body: JSON.stringify(updates)
  });

  if (!response.ok) {
    const error = await response.json();
    throw new Error(error.error);
  }

  return response.json();
}

Валидация​

  • Обновляются только переданные поля
  • name: 1-100 символов
  • email: валидный email, если указан
  • website: валидный URL, если указан
  • visibility: должен соответствовать роли пользователя

Связанные эндпоинты​