Standardize TinyNode route contract across consumers (/app/* vs root)

Đang mở
  • Có gì không ổn?
#118 0 bình luận 0 reaction 0 người được giao Xem trên GitHub

Chưa có ai nhận issue này.

Đánh giá

Độ khó
5/5
Thời gian dự kiến
Hơn một tuần
Mức phù hợp với người mới
35/100
Loại issue
Tính năng
Độ rõ ràng
Cần làm rõ
Mức độ hoạt động
Ít trao đổi
Công nghệ
javascript
Lĩnh vực
api, backend-api-design, documentation, testing

Hướng nghiên cứu

Bắt đầu bằng cách xác định các định nghĩa route của TinyNode và các tích hợp consumer cho /app/create, /app/query, /app/update, /app/overwrite cùng các alias ở root. Xác định xem cả hai mẫu route có được hỗ trợ hay không, sau đó xác định surface chuẩn, phạm vi bao phủ của OpenAPI, phạm vi kiểm thử tương thích và hướng dẫn migration cần thiết để hoàn tất quyết định.

Do mô hình lập chỉ mục viết ra từ nội dung của issue.

Mô tả

copilot

During contract-seam scanning across CDH repos, I found a route-shape mismatch risk across TinyNode consumers:

  • deer uses /app/create, /app/query, /app/update, /app/overwrite
  • TPEN-services appears to use root routes /create, /query, /update, /overwrite, /delete

Recommended adjustment:

  1. Document canonical TinyNode API surface and supported aliases.
  2. Publish OpenAPI for TinyNode routes (including /app/* and root aliases if both are supported).
  3. Add compatibility tests ensuring both consumer patterns continue to work, or explicitly deprecate one pattern with migration guidance.

Why this matters:

  • Divergent route prefixes/method expectations increase break risk across consumers.

Filed by automation as requested; label: copilot.

Ngôn ngữ chính
JavaScript
Star
1
Fork
3
Merge trung bình
12 ngày 22 giờ
Pull request đã merge (30 ngày)
1

Chuẩn bị môi trường

Bắt đầu từ đâu

  1. Đọc hết issue, rồi đọc hướng dẫn đóng góp của dự án.
  2. Bình luận trên issue rằng bạn sẽ nhận — tránh hai người làm cùng một việc.
  3. Fork repository và làm thay đổi trên một nhánh.
  4. Mở pull request có tham chiếu số hiệu của issue.

Issue khác của CenterForDigitalHumanities/TinyNode

Tất cả issue của CenterForDigitalHumanities/TinyNode

Issue tương tự

Thêm issue về JavaScript

Nhận issue mới trong hộp thư của bạn

Bản tóm tắt ngắn những issue GitHub phù hợp với người mới.