Files
mtusi2026lab3/openspec/changes/instance-id-idempotency/specs/api-conventions/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

2.2 KiB
Raw Blame History

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