connector-catalog-public@1.0.0
Danh mục connector công khai
Đọc danh mục các loại connector Apus đã công bố và mức sẵn sàng của từng loại. Không cần xác thực.
Dựng từ hợp đồng đã đóng băng, phiên bản 1.0.0. Phiên bản đã đóng băng không bao giờ bị sửa.
Thao tác
get/v1/public/connectors
Trả toàn bộ danh mục trong một phản hồi, không phân trang. Gửi If-None-Match với ETag đã giữ để nhận 304 khi danh mục chưa đổi.
Không cần xác thực · getPublicConnectorCatalog
Tham số
| Tên | Vị trí | Kiểu | Bắt buộc |
|---|---|---|---|
| If-None-Match | header | string | Không |
Phản hồi
200— Danh mục hiện tại. Mảng rỗng là hợp lệ: chưa công bố loại nào.304— Danh mục chưa đổi kể từ ETag đã gửi.500— Không dựng được danh mục. Xử lý như chưa có dữ liệu, đừng hiển thị danh mục rỗng.
Mô hình dữ liệu
ConnectorCatalog
| Trường | Kiểu | Bắt buộc | Mô tả |
|---|---|---|---|
| contract | "connector-catalog-public/1.0.0" | Có | Phiên bản hợp đồng đang phục vụ. |
| generated_at | string (date-time) | Có | Thời điểm danh mục được dựng (UTC, RFC 3339). |
| connectors | PublicConnector[] | Có | Toàn bộ các loại đã công bố; có thể rỗng. |
PublicConnector
| Trường | Kiểu | Bắt buộc | Mô tả |
|---|---|---|---|
| key | string | Có | Định danh vĩnh viễn của loại connector; an toàn để dùng làm neo liên kết. |
| name | string | Có | Tên hiển thị; không dùng để so khớp. |
| direction | inbound_api | webhook_out | polling_adapter | Có | Hướng dữ liệu: vào qua API, ra qua webhook có ký, hoặc kéo định kỳ. |
| status | live | beta | roadmap | Có | Mức sẵn sàng: live, beta hoặc roadmap. |
| summary | string | Không | Mô tả ngắn, tuỳ chọn. |
| docs_url | string (uri) | Không | Trang tài liệu công khai của loại này, tuỳ chọn. |