2.2 KiB
2.2 KiB
Spec Delta
ADDED 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