Architecture Decision Records — StatusPro OpenAPI Client¶
This directory contains Architecture Decision Records (ADRs) specific to the
statuspro-openapi-client package.
Inherited from the parent project. This repository was forked from
katana-openapi-client. The decisions captured here still apply to StatusPro (transport-layer resilience, OpenAPI codegen, response unwrapping, Pydantic domain models); some examples may still reference the original project's domain objects until the ADRs are rewritten.
Format¶
We use the format proposed by Michael Nygard in Documenting Architecture Decisions:
- Title — noun phrase describing the decision
- Status — Proposed | Accepted | Deprecated | Superseded
- Context — what is motivating this decision?
- Decision — what is the change being proposed?
- Consequences — what becomes easier or harder?
Index¶
Accepted¶
- ADR-001: Transport-Layer Resilience
- ADR-002: Generate Client from OpenAPI Specification
- ADR-003: Transparent Automatic Pagination
- ADR-004: Defer Observability to httpx
- ADR-005: Provide Both Sync and Async APIs
- ADR-006: Utility Functions for Response Unwrapping
- ADR-011: Pydantic Domain Models for Business Entities
- ADR-012: Validation Tiers for Agent Workflows