Danh mục API¶
Danh mục API · nhóm 1 · 8 story · 🟡 chưa viết xong · còn 19 mốc
Chưa viết xong: còn 19 mốc
Phần chưa viết hiển thị tiêu chí dự kiến từ kế hoạch (đã qua cổng PO duyệt) và mốc chờ agent làn docs.
| Story | Service | Thứ tự | Ghi chú |
|---|---|---|---|
E-002/1.1 Schema và API Domain, Subdomain |
admin-be | 1 | cap/api-catalog · quy tắc mã 64 ký tự |
E-002/1.2 Màn Domain và Subdomain |
admin-fe | 2 | cap/admin-console-ui · sửa bằng modal (UX-DR13) |
E-002/1.3 Schema và API danh mục API |
admin-be | 3 | cap/api-catalog · AD-21 · nhãn nhóm mặc định UNCLASSIFIED, ⛔ chỉ đổi qua luồng 1.6 |
E-002/1.4 Màn danh mục API |
admin-fe | 4 | cap/admin-console-ui · phân trang máy chủ cho 1.069 bản ghi |
E-002/1.5 Nhập danh mục API hàng loạt |
admin-be | 5 | cap/api-catalog · ⚠️ BỊ CHẶN: nguồn nhập chưa chốt |
E-002/1.6 Luồng phân loại nhóm TT64 |
admin-be | 6 | cap/api-catalog · AD-21, AD-9 · lô cho INF/AIS/OUT_OF_SCOPE, từng API cho PIS/EWLTS |
E-002/1.7 Màn phân loại theo lô |
admin-fe | 7 | cap/admin-console-ui · chọn theo Domain hoặc Subdomain, xem trước rồi gửi duyệt |
E-002/1.8 Đặc tả API |
admin-be | 8 | cap/api-catalog · PO duyệt 12/09 · mỗi API mang tài liệu OpenAPI (mô tả · tham số M/O · request/response mẫu · mã lỗi); response mẫu chính là FR-105 · GĐ1 nhập tay vài API theo luật §F UU-TIEN-GD1 |
Vì sao làm — BRD¶
→ Mục tiêu và giá trị nghiệp vụ nằm ở Tổng quan epic. Ở đây chỉ ghi mỗi story góp gì vào mục tiêu đó.
E-002/1.1 Schema và API Domain, Subdomain — admin-be¶
⟨CẦN NGƯỜI VIẾT — agent làn admin-be viết khi đóng change⟩
E-002/1.2 Màn Domain và Subdomain — admin-fe¶
⟨CẦN NGƯỜI VIẾT — agent làn admin-fe viết khi đóng change⟩
E-002/1.3 Schema và API danh mục API — admin-be¶
⟨CẦN NGƯỜI VIẾT — agent làn admin-be viết khi đóng change⟩
E-002/1.4 Màn danh mục API — admin-fe¶
⟨CẦN NGƯỜI VIẾT — agent làn admin-fe viết khi đóng change⟩
E-002/1.5 Nhập danh mục API hàng loạt — admin-be¶
⟨CẦN NGƯỜI VIẾT — agent làn admin-be viết khi đóng change⟩
E-002/1.6 Luồng phân loại nhóm TT64 — admin-be¶
⟨CẦN NGƯỜI VIẾT — agent làn admin-be viết khi đóng change⟩
E-002/1.7 Màn phân loại theo lô — admin-fe¶
⟨CẦN NGƯỜI VIẾT — agent làn admin-fe viết khi đóng change⟩
E-002/1.8 Đặc tả API — admin-be¶
⟨CẦN NGƯỜI VIẾT — agent làn admin-be viết khi đóng change⟩
Ai dùng, dùng thế nào — URD¶
Một hành trình cho cả nhóm, kể từ bề mặt người dùng chạm vào.
E-002/1.2 Màn Domain và Subdomain — admin-fe¶
⟨CẦN NGƯỜI VIẾT — agent làn admin-fe viết khi đóng change⟩
E-002/1.4 Màn danh mục API — admin-fe¶
⟨CẦN NGƯỜI VIẾT — agent làn admin-fe viết khi đóng change⟩
E-002/1.7 Màn phân loại theo lô — admin-fe¶
⟨CẦN NGƯỜI VIẾT — agent làn admin-fe viết khi đóng change⟩
Hệ làm gì, ràng buộc gì — PRD¶
Mỗi story một mục, phần máy chủ trước, giao diện sau. Story chưa đóng hiển thị tiêu chí dự kiến từ epics.md.
E-002/1.1 Schema và API Domain, Subdomain — admin-be¶
Chờ hồ sơ. Tiêu chí dự kiến từ kế hoạch:
- Domain: mã, tên, trạng thái, mô tả. Subdomain: mã, tên, thuộc Domain, trạng thái, mô tả (
FR-061,FR-063). - Mã theo quy tắc in hoa, số,
_,., tối đa 64 ký tự (FR-062). - Subdomain được phép chưa thuộc Domain nào (
FR-064) —[ASSUMPTION], chờ nghiệp vụ xác nhận. - Ngưng hoạt động Domain phải nêu ảnh hưởng tới Subdomain và API bên dưới, không xoá ngầm (
FR-065).
⟨CẦN NGƯỜI VIẾT — agent làn admin-be viết khi đóng change⟩
E-002/1.3 Schema và API danh mục API — admin-be¶
Chờ hồ sơ. Tiêu chí dự kiến từ kế hoạch:
- API: tên, Domain, Subdomain, phiên bản, trạng thái Đã xuất bản / Ngừng hỗ trợ (
FR-067). - Hai địa chỉ:
API ENDPOINTnội bộ vàAPI EXPOSEphơi ra;API EXPOSEtheohttps://<domain>/api/v1/…(FR-068,FR-069). - Nhãn nhóm TT64 năm giá trị
INF·AIS·PIS·EWLTS·OUT_OF_SCOPE, cộngUNCLASSIFIEDlà mặc định khi tạo (FR-070,AD-21). - ⛔ Fail-closed ở tầng tiêu thụ, không ở tầng nhập: tạo và nhập để
UNCLASSIFIEDđược; APIUNCLASSIFIEDkhông đóng được vào sản phẩm nào. Buộc gõ nhãn lúc nhập là ép người ta gõ bừa — kiểu hỏng nguy hiểm nhất ở đây. - ⛔
OUT_OF_SCOPEkhácUNCLASSIFIED: đã xác định là ngoài phạm vi khác chưa ai xem. Một cột không phân biệt được hai cái đó thì cổng không chặn được gì. - Mã API chuẩn theo Phụ lục 01 cho nhóm cơ bản (
FR-071). - Đổi trạng thái sang Ngừng hỗ trợ cảnh báo các Sản phẩm đang chứa nó (
FR-072).
⟨CẦN NGƯỜI VIẾT — agent làn admin-be viết khi đóng change⟩
E-002/1.5 Nhập danh mục API hàng loạt — admin-be¶
Chờ hồ sơ. Tiêu chí dự kiến từ kế hoạch:
- Nhập nhiều API một lần (
FR-074) — 1.069 bản ghi không nhập tay từng cái được. - ⚠️ Story này bị chặn: nguồn nhập chưa chốt (OpenAPI spec, CSV, hay đọc từ Kong).
- Bản ghi nhập vào mang
UNCLASSIFIED; phân loại là việc của1.6.
⟨CẦN NGƯỜI VIẾT — agent làn admin-be viết khi đóng change⟩
E-002/1.6 Luồng phân loại nhóm TT64 — admin-be¶
Chờ hồ sơ. Tiêu chí dự kiến từ kế hoạch:
- Phân loại đi maker/checker (
AD-9), không phải một ô sửa tự do trên form API. - Duyệt theo lô cho
INF,AIS,OUT_OF_SCOPE: chọn cả Domain, cả Subdomain, hoặc một tập API chọn tay. Hai mươi bảy Domain rẻ hơn 1.069 lần duyệt. - ⛔ Gán
PIShoặcEWLTSluôn từng API một — nhóm khoản 3 Điều 5 giới hạn đối tượng, duyệt cả cụm là ký cho thứ mình chưa đọc. - ⛔ Hạ nhãn từ
PIS/EWLTSxuống nhãn nhẹ hơn: từng API, lý do bắt buộc, và rà lại mọiREGISTRATIONđang sống trên mọi sản phẩm chứa API đó (AD-21lớp 5). - Quyết định phân loại là bản ghi riêng bất biến (ai, khi nào, phạm vi, lý do); mỗi API mang con trỏ tới quyết định đã duyệt của chính nó. Một dòng cho cả lô thì ba tháng sau không trả lời được «API này ai gán nhãn, căn cứ gì».
⟨CẦN NGƯỜI VIẾT — agent làn admin-be viết khi đóng change⟩
E-002/1.8 Đặc tả API — admin-be¶
Chờ hồ sơ. Tiêu chí dự kiến từ kế hoạch:
- Mỗi API mang tài liệu OpenAPI (hoặc các phần tương đương): mô tả · tham số với ký hiệu M/O theo bảng của Thông tư 64 · request/response mẫu · mã lỗi (
400 INVALID_REQUEST·401 EXPIRED_TOKEN·401 INVALID_TOKEN·403 FORBIDDEN·429 TOO_MANY_REQUESTS). - Response mẫu trong đặc tả là phản hồi mẫu của
FR-105—E-009/1.3đọc từ đây, không có bảng riêng. - Chỉ bản đã xuất bản phơi ra cổng TPP (
AD-20, cùng luật với danh mục). - GĐ1: nhập tay qua màn danh mục (
1.4) cho một số API đủ chạy happy case; nhập hàng loạt chờ1.5(§FUU-TIEN-GD1).
⟨CẦN NGƯỜI VIẾT — agent làn admin-be viết khi đóng change⟩
E-002/1.2 Màn Domain và Subdomain — admin-fe¶
Chờ hồ sơ. Tiêu chí dự kiến từ kế hoạch:
- Danh sách theo khuôn
E-001/5.5, có tìm kiếm, lọc, phân trang (FR-066); sửa bằng modal (UX-DR13). - Helper text dùng đúng câu của gói cho ô mã.
⟨CẦN NGƯỜI VIẾT — agent làn admin-fe viết khi đóng change⟩
E-002/1.4 Màn danh mục API — admin-fe¶
Chờ hồ sơ. Tiêu chí dự kiến từ kế hoạch:
- Danh sách 1.069 bản ghi: phân trang phía máy chủ, lọc theo Domain và theo nhóm TT64 (
FR-073,NFR-010). - Form tạo và sửa. ⛔ Nhãn nhóm là trường CHỈ ĐỌC ở đây, hiển thị kèm con trỏ tới quyết định phân loại đã duyệt.
- Vì sao chỉ đọc: cho sửa nhãn trên form API thường là mở đường vòng qua
1.6— ai cũng đổi được nhãn mà không qua checker, và lớp 5 củaAD-21(chặn hạ nhãnPIS/EWLTS) mất hết tác dụng. Đổi nhãn có đúng một đường: luồng phân loại. - Từ danh sách có lối tắt gửi phân loại cho các bản ghi
UNCLASSIFIED, dẫn sang1.7.
⟨CẦN NGƯỜI VIẾT — agent làn admin-fe viết khi đóng change⟩
E-002/1.7 Màn phân loại theo lô — admin-fe¶
Chờ hồ sơ. Tiêu chí dự kiến từ kế hoạch:
- Chọn phạm vi theo Domain hoặc Subdomain, hoặc chọn tay nhiều API trong danh sách.
- Xem trước trước khi gửi duyệt: bao nhiêu API bị chạm, cái nào đang có nhãn rồi và sẽ bị đổi.
- Ô chọn nhãn không có giá trị mặc định;
PISvàEWLTSkhông xuất hiện ở màn lô — muốn gán hai nhãn đó thì đi đường từng API, và giao diện phải nói rõ vì sao chứ không im lặng ẩn đi. - Hàng chờ duyệt dùng khuôn
E-001/3.3.
⟨CẦN NGƯỜI VIẾT — agent làn admin-fe viết khi đóng change⟩