You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
Repository navigation
STORY: Establish API contract and documentation standards #81
Establish the Sprint 1 REST API contract baseline for the Customer and Account services.
Scope
Keep OpenAPI contracts owned and versioned by each service.
Provide predictable internal contract paths.
Make service contracts centrally discoverable through API Gateway Swagger UI.
Document the current ProblemDetail error, pagination, and monetary-value conventions.
Use synthetic examples only.
Security policy, production access control, Kafka/AsyncAPI contracts, and CI breaking-change detection are tracked by later Sprint 3, Sprint 4, Sprint 6, and Sprint 7 work.
Definition of Done
Customer Service and Account Service expose explicit OpenAPI metadata and documented REST contracts.
API Gateway provides named central documentation routes.
Gateway behavior when a documentation backend is unavailable is verified.
Related Sprint 1 tasks are complete and later-sprint governance work is linked rather than blocking this outcome.
Activity
ramioooz commentedon Aug 3, 2026
Sprint 1 implementation set is now under review:\n- Organization conventions: https://github.com/digital-bank-java/.github/pull/129\n- Customer Service contract: https://github.com/digital-bank-java/customer-service/pull/34\n- Account Service contract: https://github.com/digital-bank-java/account-service/pull/32\n- API Gateway resilience verification: https://github.com/digital-bank-java/api-gateway/pull/19\n\nMerge order: organization documentation first; Customer and Account in either order; Gateway after the service PRs.
ramioooz commentedon Aug 3, 2026
Sprint 1 REST contract outcome completed through .github#129, customer-service#34, account-service#32, and api-gateway#19.