Chuyển tới nội dung chính

API Job Sources

Tiền tố /api/v1/job-sources. Controller: job-sources.controller.ts. Tài liệu sâu: 03-modules/job-ingestion.md (Phase 3). Collection: job-sources, crawl-runs.

Toàn bộ route chỉ cho SUPER ADMIN (@Roles ở cấp class).

Danh sách route​

RouteAuthMô tả
GET /api/v1/job-sourcesĐăng nhập, vai trò: SUPER ADMINLiệt kê các nguồn kèm trạng thái đồng bộ gần nhất
PATCH /api/v1/job-sources/:keyĐăng nhập, vai trò: SUPER ADMINBật tắt đồng bộ hoặc đổi chính sách hiển thị công khai
GET /api/v1/job-sources/:key/runsĐăng nhập, vai trò: SUPER ADMINLịch sử các lần đồng bộ gần nhất của một nguồn, mới nhất trước
POST /api/v1/job-sources/:key/syncĐăng nhập, vai trò: SUPER ADMINĐưa một lần đồng bộ của nguồn vào hàng đợi

Ghi chú​

  • PATCH /job-sources/:key chỉ nhận hai field: enabled (bật tắt đồng bộ định kỳ) và displayPolicy (FULL, LINK_ONLY, HIDDEN). Không đổi được key, provider, boardToken.
  • POST /job-sources/:key/sync đưa việc đồng bộ vào hàng đợi job-ingestion với jobId = sync-<key>, nên bấm nhiều lần khi một lần đang chờ hoặc chạy sẽ không tạo thêm việc. Trả { key, queued: true }; trả 404 nếu key không tồn tại.
  • GET /job-sources/:key/runs: limit mặc định 20, tối đa 100, mới nhất trước.
  • Không có route tạo hoặc xóa nguồn; nguồn được nạp bằng npm run seed.

Chi tiết từng route​

GET /api/v1/job-sources​

Liệt kê các nguồn kèm trạng thái đồng bộ gần nhất

  • Auth: Đăng nhập, vai trò: SUPER ADMIN
  • Handler: findAll trong job-sources.controller.ts
  • Mã thành công: 200, message = "Get list job sources"

PATCH /api/v1/job-sources/:key​

Bật tắt đồng bộ hoặc đổi chính sách hiển thị công khai

  • Auth: Đăng nhập, vai trò: SUPER ADMIN
  • Handler: update trong job-sources.controller.ts
  • Mã thành công: 200, message = "Job source updated"

Path params

TênKiểuMô tả
keystring

Body: UpdateJobSourceDto (update-job-source.dto.ts)

FieldKiểuBắt buộcValidationVí dụ
enabledbooleanKhôngIsBoolean—
displayPolicyEJobSourceDisplayPolicyKhôngIsEnum(EJobSourceDisplayPolicy)—

GET /api/v1/job-sources/:key/runs​

Lịch sử các lần đồng bộ gần nhất của một nguồn, mới nhất trước

  • Auth: Đăng nhập, vai trò: SUPER ADMIN
  • Handler: findRuns trong job-sources.controller.ts
  • Mã thành công: 200, message = "Get job source sync runs"

Path params

TênKiểuMô tả
keystring

Query

TênBắt buộcMô tảVí dụ
(toàn bộ query string)—DTO ListCrawlRunsQueryDto

Query: ListCrawlRunsQueryDto (list-crawl-runs-query.dto.ts)

FieldKiểuBắt buộcValidationVí dụ
limitnumberKhôngIsInt, Min(1), Max(CRAWL_RUNS_MAX_LIMIT)CRAWL_RUNS_DEFAULT_LIMIT

POST /api/v1/job-sources/:key/sync​

Đưa một lần đồng bộ của nguồn vào hàng đợi

  • Auth: Đăng nhập, vai trò: SUPER ADMIN
  • Handler: sync trong job-sources.controller.ts
  • Mã thành công: HttpStatus.ACCEPTED, message = "Job source sync queued"

Path params

TênKiểuMô tả
keystring