Files
mtusi2026lab3/openspec/specs/chats/spec.md
T
ricoromaandClaude Opus 5.5 af4bca08c9 feat: carry lab 2 over and add X-Instance-Id and idempotency keys
- carry the lab 2 solution over and plan lab 3 (PLAN.md, OpenSpec
  change instance-id-idempotency)
- rename the compose project to mtusi-lab3 and the image to :lab3
- add X-Instance-Id to every response and instance_id to every log
  record ([app] instance_id, hostname by default)
- require Idempotency-Key on POST messages: keys table in Postgres,
  key and message in one transaction, replay returns the same 201,
  another body gets 409, TTL from [idempotency] ttl_seconds
- send the key from student-tests, k6 scenarios and the skill driver;
  add idempotency, X-Instance-Id, key race and fault tests

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-10-08 19:42:36 +03:00

102 lines
4.5 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 совпадать с переданным списком,
включая порядок. Чат SHALL создаваться атомарно: при любой ошибке
валидации он MUST NOT появиться ни в одном списке.
#### Scenario: Успешное создание
- **WHEN** Алиса создаёт чат с `member_ids` = [Алиса, Боб]
- **THEN** ответ 201, `member_ids` равен [Алиса, Боб], `id` — новый UUID
### Requirement: Валидация чата
`title` SHALL содержать 1–100 Unicode code points и MUST NOT состоять
только из пробельных символов. `member_ids` SHALL содержать от 1 до 100
UUID без повторов; каждый MUST быть идентификатором существующего
пользователя, и текущий пользователь MUST входить в список. Нарушение
любого условия SHALL давать 400 `invalid_request`.
#### Scenario: Вызывающего нет в списке
- **WHEN** Алиса создаёт чат с `member_ids` = [Боб]
- **THEN** ответ 400
#### Scenario: Повтор участника
- **WHEN** `member_ids` = [Алиса, Алиса]
- **THEN** ответ 400
#### Scenario: Неизвестный участник
- **WHEN** `member_ids` содержит UUID, которого нет среди пользователей
- **THEN** ответ 400
#### Scenario: Пустой список
- **WHEN** `member_ids` = []
- **THEN** ответ 400
### 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` каждый раз одинаков