Files
mtusi2026lab3/openspec/changes/replicas-lb/specs/api-conventions/spec.md
T
ricoromaandClaude Opus 5.5 8e15e02898 docs: propose replicas-lb change
HAProxy as the single entry point, API replicas without published
ports, resource limits and per-service secrets, restart and stop-one
hooks, replica tests in student-tests.

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

44 lines
2.6 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.
# Spec Delta
## MODIFIED Requirements
### Requirement: X-Instance-Id на каждом ответе
Каждый ответ, созданный API, SHALL содержать непустой заголовок
`X-Instance-Id` — идентификатор процесса, который обслужил запрос.
Это касается успешных ответов, ошибок, health, ответа на неизвестный
путь и неподдерживаемый метод, ответа на непредвиденное исключение.
Значение SHALL быть одним для всех ответов процесса, пока он работает,
и различаться у одновременно работающих процессов. Значение SHALL
состоять из ASCII-символов `A–Z`, `a–z`, `0–9`, `.`, `_`, `-`.
Требование не распространяется на ответы, которые создал не API, а
балансировщик при недоступности реплик.
#### Scenario: Instance id в успешном ответе и ошибке
- **WHEN** клиент получает ответы 200 и 201 и ответы с ошибками 400,
401, 404 и 409
- **THEN** каждый ответ содержит непустой `X-Instance-Id` допустимого
формата
#### Scenario: Instance id в health и служебных ответах
- **WHEN** клиент запрашивает `/health/live`, `/health/ready`,
`GET /api/v1/unknown` и `DELETE /api/v1/users`
- **THEN** каждый ответ содержит непустой `X-Instance-Id`
#### Scenario: Instance id в ответе 500
- **WHEN** обработка запроса завершается непредвиденным исключением
- **THEN** ответ 500 тоже содержит `X-Instance-Id` того же процесса
#### Scenario: Одно значение на процесс
- **WHEN** клиент дважды подряд выполняет одну и ту же серию разных
запросов — к одному процессу API или через балансировщик к
нескольким репликам
- **THEN** против одного процесса все ответы содержат одно значение
`X-Instance-Id`; через балансировщик каждое значение встречается
больше чем в одном ответе, а во второй серии нет значений, которых не
было в первой