Files
mtusi2026lab4/openspec/specs/chats/spec.md
T
ricoromaandClaude Opus 5.5 5d5d8f9d2a chore: carry lab 3 over
- carry the lab 3 solution over from mtusi2026lab3-safronov
  (solution/bvt2301-safronov, ce89eba): src, migrations, student-tests,
  bench, openspec, .claude, infra/haproxy and infra/valkey, own scripts,
  Dockerfile, compose, pyproject and uv lock
- merge Makefile, .gitignore and .dockerignore (the lab 3 versions only
  add lines to the skeleton, which is the same in lab 4) and
  .env.example (lab 4 skeleton names listed in the header)
- rename the compose project to mtusi-lab4 and the image to :lab4 so
  the stand does not reuse the lab 3 containers and volumes
- update AGENTS.md for lab 4: current lab, origin commit, contract and
  test files of the new skeleton

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-10-20 17:32:33 +03:00

125 lines
5.9 KiB
Markdown
Raw Blame History

This file contains ambiguous Unicode characters
This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.
# chats Specification
## Purpose
Чаты — группы пользователей с фиксированным составом, в которых идёт
переписка. Capability описывает создание, получение и список чатов
текущего пользователя, а также правило «чат видят только участники».
## Requirements
### Requirement: Создание чата
`POST /api/v1/chats` SHALL принимать тело
`{"title": ..., "member_ids": [...]}` и при успехе отвечать 201 с
объектом `Chat`: `id`, `title`, `member_ids`, `created_at`, без других
полей. `member_ids` в ответе SHALL совпадать с переданным списком,
включая порядок: те же UUID в том же порядке, записанные в нижнем
регистре, даже если клиент передал их в верхнем (требования `api-conventions`
«UUID на входе» и «Представление времени и идентификаторов»). Чат SHALL
создаваться атомарно: при любой ошибке валидации он MUST NOT появиться
ни в одном списке.
#### Scenario: Успешное создание
- **WHEN** Алиса создаёт чат с `member_ids` = [Алиса, Боб]
- **THEN** ответ 201, `member_ids` равен [Алиса, Боб], `id` — новый UUID
#### Scenario: Участник в верхнем регистре
- **WHEN** Алиса создаёт чат с `member_ids` = [Алиса, Боб], где id Боба
записан в верхнем регистре
- **THEN** ответ 201, `member_ids` равен [Алиса, Боб] в нижнем регистре,
и Боб видит чат в своём списке
### Requirement: Валидация чата
`title` SHALL содержать 1–100 Unicode code points и MUST NOT состоять
только из пробельных символов. `member_ids` SHALL быть массивом от 1 до
100 UUID без повторов; повтором SHALL считаться тот же UUID в любой
допустимой записи. Каждый элемент MUST быть идентификатором
существующего пользователя, и текущий пользователь MUST входить в
список. Нарушение любого условия SHALL давать 400 `invalid_request`.
#### Scenario: Вызывающего нет в списке
- **WHEN** Алиса создаёт чат с `member_ids` = [Боб]
- **THEN** ответ 400
#### Scenario: Повтор участника
- **WHEN** `member_ids` = [Алиса, Алиса]
- **THEN** ответ 400
#### Scenario: Повтор участника в другом регистре
- **WHEN** `member_ids` = [Алиса, Алиса], где второй id записан в
верхнем регистре
- **THEN** ответ 400, чат не создан
#### Scenario: Неизвестный участник
- **WHEN** `member_ids` содержит UUID, которого нет среди пользователей
- **THEN** ответ 400
#### Scenario: Пустой список
- **WHEN** `member_ids` = []
- **THEN** ответ 400
#### Scenario: member_ids не массив
- **WHEN** `member_ids` равен `{}`, `123`, `false` или строке с id Алисы
вместо массива
- **THEN** ответ 400 с `code` `invalid_request`, чат не создан
### Requirement: Получение чата
`GET /api/v1/chats/{chat_id}` SHALL отвечать 200 с объектом `Chat`,
если текущий пользователь — участник. Если чата нет или пользователь
не участник, сервис SHALL отвечать одинаковым 404 `not_found` и MUST
NOT использовать 403. `chat_id`, не являющийся UUID, SHALL давать 400.
#### Scenario: Участник
- **WHEN** Боб запрашивает чат, в котором состоит
- **THEN** ответ 200 с этим чатом
#### Scenario: Посторонний
- **WHEN** Ева запрашивает существующий чат Алисы и Боба
- **THEN** ответ 404 с `code` `not_found`, неотличимый от ответа на
несуществующий чат
#### Scenario: Неверный chat_id
- **WHEN** `chat_id` равен `nope`
- **THEN** ответ 400
### Requirement: Список чатов пользователя
`GET /api/v1/chats` SHALL возвращать только чаты, в которых состоит
текущий пользователь, в порядке `(created_at, id)` по возрастанию, с
постраничным выводом по capability `pagination`.
#### Scenario: Участник видит чат
- **WHEN** Боб запрашивает список чатов после того, как Алиса создала
чат с ним
- **THEN** этот чат есть в списке
#### Scenario: Посторонний не видит чат
- **WHEN** Ева запрашивает список чатов
- **THEN** чата Алисы и Боба в нём нет
### Requirement: Состав чата неизменен
После создания состав участников чата SHALL оставаться неизменным: API
лабы 1 не предоставляет операций добавления и удаления участников.
#### Scenario: Повторное чтение
- **WHEN** участник читает чат в разное время
- **THEN** `member_ids` каждый раз одинаков