Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
30 commits
Select commit Hold shift + click to select a range
11dc302
Add workflow management design research
mryhmln Jan 16, 2026
188c1af
Expand workflow design to comprehensive domain-driven design
mryhmln Jan 16, 2026
4482517
Move domain design to docs/architecture/
mryhmln Jan 16, 2026
fe7a0e7
Make Communication a cross-cutting concern and fix data flow
mryhmln Jan 16, 2026
40d59a7
Add workflow capability gaps and split architecture into domain files
mryhmln Jan 16, 2026
bfcb16d
Add Staffing Forecasting to Future Considerations
mryhmln Jan 16, 2026
db7e7be
Unify AssignmentRule and PriorityRule into WorkflowRule
mryhmln Jan 16, 2026
6bec8e9
Rename CaseWorkerCertification to CaseWorkerSkill
mryhmln Jan 16, 2026
8c49ed0
Add Capabilities section to Case Management domain
mryhmln Jan 16, 2026
4763429
Add Capabilities sections with clarifying notes
mryhmln Jan 16, 2026
b48e149
Add API Layer Organization, Vendor Independence, and Operational Arch…
mryhmln Jan 20, 2026
1d0323b
Add architectural decisions for API organization and operations
mryhmln Jan 20, 2026
2f81e90
Add decision: no Experience Layer now, GraphQL later
mryhmln Jan 20, 2026
3a9887a
Fix cross-cutting concerns consistency
mryhmln Jan 20, 2026
162df3b
Add documentation gaps and new API patterns
mryhmln Jan 20, 2026
748490d
Add API type applicability annotations to api-patterns.yaml
mryhmln Jan 20, 2026
947f966
Add security patterns to api-patterns.yaml
mryhmln Jan 20, 2026
e239dc0
Refactor architecture docs and add API patterns
mryhmln Jan 20, 2026
0dcc0aa
Remove redundant domain schema section from architecture README
mryhmln Jan 20, 2026
2165405
Update main README to link to architecture index
mryhmln Jan 20, 2026
eb3b99a
Add Process APIs for Workflow and Case Management domains
mryhmln Jan 20, 2026
fea2518
Standardize Process API path convention: /processes/{domain}/{resourc…
mryhmln Jan 20, 2026
f24f46b
Complete documentation gaps and align x-capability values
mryhmln Jan 20, 2026
badefc2
Update capability tables to reference Process APIs
mryhmln Jan 20, 2026
6c94eb1
Update communication capability table to reference Process APIs
mryhmln Jan 20, 2026
1bec4e7
Consolidate workflow capabilities and add Create Task API
mryhmln Jan 20, 2026
adeebe7
Clarify Tasks vs Cases and add case capabilities
mryhmln Jan 20, 2026
aa26627
Refactor workflow schemas for extensibility
mryhmln Jan 20, 2026
4673002
Add architectural quality attributes documentation
mryhmln Jan 20, 2026
952bcc1
Consolidate EligibilityRequest and clarify document status
mryhmln Jan 20, 2026
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 4 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

This toolkit helps teams build consistent, well-documented APIs for safety net programs—enabling faster integration between benefits systems and reducing the technical barriers to improving service delivery.

**New here?** Start with the [Executive Summary](./docs/presentation/executive-summary.md) for a one-page overview, or view the [Toolkit Overview](https://codeforamerica.github.io/safety-net-openapi/presentation/safety-net-openapi-overview.html) presentation for a detailed walkthrough.
**New here?** Start with the [Executive Summary](./docs/presentation/executive-summary.md) for a one-page overview, or view the [Toolkit Overview](https://codeforamerica.github.io/safety-net-openapi/presentation/safety-net-openapi-overview.html) presentation for a detailed walkthrough. For the technical design, see the [Domain Architecture](./docs/architecture/domain-design.md).

## About This Repository

Expand Down Expand Up @@ -67,6 +67,9 @@ Visit `http://localhost:3000` for interactive API docs.
- [Project Structure](./docs/reference/project-structure.md) — File layout and conventions
- [Troubleshooting](./docs/reference/troubleshooting.md) — Common issues and solutions

### Architecture
- [Architecture Overview](./docs/architecture/README.md) — Domain design, API architecture, design decisions, and roadmap

### Architecture Decisions
- [Multi-State Overlays](./docs/architecture-decisions/multi-state-overlays.md)
- [Search Patterns](./docs/architecture-decisions/search-patterns.md)
Expand Down
23 changes: 23 additions & 0 deletions docs/architecture/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
# Architecture Documentation

This directory contains architecture documentation for the Safety Net Benefits API.

> **Status: Proposed Architecture**
> These documents describe the target architecture. The current implementation includes only a subset (Intake with Applications and Persons). The remaining domains and functionality are planned for future development.

## Documents

| Document | Description |
|----------|-------------|
| [Domain Design](domain-design.md) | Domain organization, entities, data flow, and safety net concerns |
| [API Architecture](api-architecture.md) | API layers, vendor independence, and operational architecture |
| [Design Decisions](design-decisions.md) | Key decisions with rationale and alternatives considered |
| [Roadmap](roadmap.md) | Migration, implementation phases, future considerations, and documentation gaps |

## Related Resources

| Resource | Description |
|----------|-------------|
| [api-patterns.yaml](../../packages/schemas/openapi/patterns/api-patterns.yaml) | Machine-readable API design patterns |
| [Architecture Decision Records](../architecture-decisions/) | Formal ADRs for significant decisions |
| [Guides](../guides/) | How-to guides for working with the toolkit |
Loading