Skip to content

Commit 0c0b3b5

Browse files
committed
docs: 1.4 기준 OpenAPI/가이드/체크리스트 동기화
1 parent 57b820f commit 0c0b3b5

5 files changed

Lines changed: 70 additions & 16 deletions

File tree

TODO.md

Lines changed: 10 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -30,15 +30,17 @@ Source: `docs/v2_FINANCIAL-LEDGER/roadmap/01-development-plan.md`
3030

3131
## 1.4 Test & Docs
3232

33-
- [ ] Unit tests (Vitest)
34-
- [ ] Integration tests
35-
- [ ] OpenAPI docs baseline
36-
- [ ] Developer guide updates
37-
- [ ] README sync with implementation
33+
- [x] Unit tests (Vitest)
34+
- [x] Integration tests
35+
- [x] OpenAPI docs baseline
36+
- [x] Developer guide updates
37+
- [x] README sync with implementation
3838

3939
## Phase 1 Milestone Checks
4040

41-
- [ ] Core layer completed
42-
- [ ] Module loader working
41+
- [x] Core layer completed
42+
- [x] Module loader working
4343
- [ ] Coverage > 70%
44-
- [ ] Documentation complete
44+
- [x] Documentation complete
45+
46+
Coverage note: current baseline coverage is below 70% and requires additional test expansion.

docs/v2_FINANCIAL-LEDGER/README.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -104,6 +104,7 @@ pnpm start
104104
- [🤖 AI 통합](technical/03-ai-integration.md)
105105
- [🔐 인증](technical/02-authentication.md)
106106
- [⏰ Scheduler](technical/04-scheduler.md)
107+
- [📘 OpenAPI Baseline](technical/05-openapi-baseline.yaml)
107108

108109
### 모듈 개발
109110
- [📦 모듈 시스템](modules/03-system-design.md)

docs/v2_FINANCIAL-LEDGER/modules/01-development-guide.md

Lines changed: 11 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -243,10 +243,16 @@ module-registry 저장소에 PR 제출
243243
- 📖 `architecture/00-overview.md § Module Layer` - 모듈 레이어 설명
244244
- 📖 `architecture/04-directory-structure.md` - 디렉터리 구조
245245

246-
### 기술
247-
- 📖 `technical/01-database.md` - DB 추상화 레이어
248-
- 📖 `technical/04-scheduler.md` - Scheduler 사용법
249-
- 📖 `modules/02-integrations.md` - 외부 서비스 통합
246+
### 기술
247+
- 📖 `technical/01-database.md` - DB 추상화 레이어
248+
- 📖 `technical/04-scheduler.md` - Scheduler 사용법
249+
- 📖 `technical/05-openapi-baseline.yaml` - OpenAPI baseline
250+
- 📖 `modules/02-integrations.md` - 외부 서비스 통합
251+
252+
### 테스트 베이스라인 (Phase 1.4)
253+
- Vitest 기반 단위 테스트는 `packages/core/src/**/*.test.ts`에 추가합니다.
254+
- API 통합 스모크 테스트는 `apps/api/src/integration/*.test.ts`에 추가합니다.
255+
- 모듈 로더 계약 검증은 `apps/api/src/loader/index.test.ts`를 기준으로 확장합니다.
250256

251257
### UI
252258
- 📖 `ui/01-core-components.md` - Core UI 컴포넌트
@@ -269,4 +275,4 @@ module-registry 저장소에 PR 제출
269275

270276
> 💬 **도움이 필요하신가요?**
271277
> → Discord: https://discord.gg/5m4aHKmWgg
272-
> → GitHub Discussions: https://github.com/.../discussions
278+
> → GitHub Discussions: https://github.com/.../discussions

docs/v2_FINANCIAL-LEDGER/roadmap/01-development-plan.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -92,9 +92,9 @@ Fieldstack/
9292
#### 1.4 테스트 & 문서
9393
**예상 기간: 2주**
9494

95-
- [ ] 단위 테스트 (Vitest)
96-
- [ ] 통합 테스트
97-
- [ ] API 문서 (OpenAPI) (설계 완료)
95+
- [x] 단위 테스트 (Vitest)
96+
- [x] 통합 테스트
97+
- [x] API 문서 (OpenAPI) (설계 완료)
9898
- [x] 개발자 가이드
9999
- [x] README 작성
100100

Lines changed: 45 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,45 @@
1+
openapi: 3.1.0
2+
info:
3+
title: Fieldstack API Baseline
4+
version: 0.1.0
5+
description: |
6+
Phase 1.4 baseline OpenAPI document.
7+
This file defines minimal health/module endpoints to bootstrap API documentation workflow.
8+
servers:
9+
- url: http://localhost:3000
10+
paths:
11+
/api/health:
12+
get:
13+
summary: Health check
14+
operationId: getHealth
15+
responses:
16+
"200":
17+
description: Service is healthy
18+
content:
19+
application/json:
20+
schema:
21+
type: object
22+
properties:
23+
status:
24+
type: string
25+
example: ok
26+
/api/modules:
27+
get:
28+
summary: List enabled modules
29+
operationId: listModules
30+
responses:
31+
"200":
32+
description: Enabled module list
33+
content:
34+
application/json:
35+
schema:
36+
type: array
37+
items:
38+
type: object
39+
properties:
40+
name:
41+
type: string
42+
version:
43+
type: string
44+
enabled:
45+
type: boolean

0 commit comments

Comments
 (0)