Bỏ qua

Theo dõi API — đọc thế nào

Vùng này do MÁY SINH

Ba trang ở đây được tool/render-theo-doi-api.py dựng từ openapi.yamlopenspec/changes/ của hai repo máy chủ (origin/*) đối chiếu với sổ kế hoạch so-api.tsv. Sửa ở đây là mất khi render lại. Muốn thêm endpoint dự kiến, đổi nhóm, đổi story ⇒ sửa sổ rồi render; muốn đổi trạng thái ⇒ không sửa gì cả — trạng thái là hình chiếu của kho mã.

Tổng hợp

🟢 67 hoàn thành · 🟡 2 đang làm · ⚪ 29 chưa làm — tính trên 98 dòng của cả hai repo.

Repo 🟢 Hoàn thành 🟡 Đang làm ⚪ Chưa làm Nguồn
admin-be 51 2 22 origin/main bf6e00e
portal-be 16 0 7 origin/main 24e5076

Ba đèn nghĩa là gì

Đèn Dòng endpoint (có method/đường) Dòng cấp story (đường «—»)
⚪ chưa làm không có trong openapi.yaml ở nhánh nào chưa change nào khai story: này
🟡 đang làm có ở openapi.yaml của một nhánh chưa gộp vào main có change đang mở khai story này (trên main hoặc nhánh)
🟢 hoàn thành có ở openapi.yaml @ origin/main — cổng hợp đồng ở repo bảo đảm route thật + test change khai story đã đóng (archive) — ⚠️ nghĩa là việc xong, không phải đường HTTP đã có

Dòng cấp story tồn tại vì hoạch định chỉ kê story, không kê endpoint: tới khi change mở và khai openapi.yaml, chưa ai biết đường HTTP tên gì. Change mở ⇒ làn docs chuyển dòng đó thành các dòng endpoint.

Theo nhóm việc

Nhóm = nhóm story, cùng cây với mục «Tài liệu kỹ thuật» — bấm sang trang nhóm để đọc BRD/URD/PRD.

Nhóm Repo 🟢 🟡 Trang
Nền cơ sở dữ liệu E-001/nhom-1 admin-be 2 0 0 bảng
Danh tính và phân quyền E-001/nhom-2 admin-be 25 0 0 bảng
Phê duyệt hai người E-001/nhom-3 admin-be 0 0 2 bảng
Nhật ký E-001/nhom-4 admin-be 0 0 1 bảng
Danh mục API E-002/nhom-1 admin-be 0 0 5 bảng
Đóng gói và định giá E-003/nhom-1 admin-be 0 0 3 bảng
Phía ngân hàng E-004/nhom-1 admin-be 2 1 1 bảng
Cổng bên thứ ba E-004/nhom-2 admin-be 0 1 0 bảng
Cổng bên thứ ba E-004/nhom-2 portal-be 13 0 2 bảng
Ứng dụng E-005/nhom-1 portal-be 0 0 1 bảng
Yêu cầu đăng ký sản phẩm E-005/nhom-2 admin-be 0 0 2 bảng
Yêu cầu đăng ký sản phẩm E-005/nhom-2 portal-be 0 0 2 bảng
Credential E-005/nhom-3 admin-be 0 0 1 bảng
Credential E-005/nhom-3 portal-be 0 0 1 bảng
Thu hồi và đình chỉ E-006/nhom-1 admin-be 0 0 4 bảng
Công bố và báo cáo E-007/nhom-1 admin-be 0 0 3 bảng
Công bố và báo cáo E-007/nhom-1 portal-be 0 0 1 bảng

Đang làm lúc render

  • admin-be · (cấp story) · E-004/1.3 Vòng đời hồ sơ — change bo-sung-hop-dong-to-chuc (nhánh bo-sung-hop-dong-to-chuc)
  • admin-be · (cấp story) · E-004/2.5 Tiếp nhận đơn nộp — change tiep-nhan-don-nop (nhánh tiep-nhan-don-nop)

Sổ thiếu dòng

  • admin-be: 22 endpoint có thật mà sổ chưa kê
  • portal-be: 3 endpoint có thật mà sổ chưa kê

Sổ kế hoạch — cách kê

Sổ là so-api.tsv, làn docs giữ tay; một dòng một endpoint (hoặc một story chưa có endpoint):

repo    nhom    story   method  path    ghi_chu
admin-be    E-002/nhom-1    E-002/1.1   —   —   Schema và API Domain, Subdomain
portal-be   E-004/nhom-2    E-004/2.2   POST    /api/v1/submissions Tạo bản nháp đơn
  • nhom đúng slug trang phe-duyet/E-00x/nhom-N.md — tên nhóm đọc từ frontmatter trang ấy, không kê lại.
  • Story chỉ schema/nền (khai bảng, di trú, khung dự án) không kê — không có bề mặt HTTP.
  • Story ràng buộc trên đường sẵn có (chống lạm dụng, chặn theo loại pháp nhân…) kê cấp story, ghi rõ «không thêm đường».
  • Endpoint có thật mà sổ chưa kê vẫn hiện ở mục «Chưa xếp vào sổ» của trang repo — sổ không thể làm mất endpoint.

Render: bash tool/render-theo-doi-api.sh — chạy cùng mốc với render-phe-duyet.sh (trước khi apply, sau khi đóng change).