cesnimda
b176a44627
Active docs/ was stub scaffolding while the real docs sat in docs/_archive/. Restore and correct them, and record the Phase 0 work. - docs/architecture/current.md: verified system map (from archived SYSTEM_OVERVIEW, 9 corrections against code). - docs/research/competitors.md: sourced competitor analysis (from archived PRODUCT_RESEARCH, feature matrix corrected). - docs/decisions/ADR-002-job-application-model.md: the Job/JobApplication split. - docs/application-discovery-report.md, docs/implementation-roadmap.md, docs/phase-0-foundation-report.md, docs/career-workspace-branch-assessment.md. - Remove 10 zero-byte placeholder files that advertised content that never existed. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
39 lines
345 B
Markdown
39 lines
345 B
Markdown
# API Design
|
|
|
|
## Principles
|
|
|
|
APIs should be:
|
|
|
|
- Predictable.
|
|
- Secure.
|
|
- Documented.
|
|
|
|
---
|
|
|
|
# Requirements
|
|
|
|
Endpoints should:
|
|
|
|
- Validate input.
|
|
- Return clear errors.
|
|
- Use correct status codes.
|
|
|
|
---
|
|
|
|
# Versioning
|
|
|
|
Future SaaS may require:
|
|
|
|
API versions.
|
|
|
|
---
|
|
|
|
# Security
|
|
|
|
Every endpoint must verify:
|
|
|
|
Authentication.
|
|
|
|
Authorization.
|
|
|
|
Ownership. |