Hacktoberfest 2026: những issue maintainer đã đánh dấu cho tháng Mười, đang mở và phù hợp người mới. Xem issue Hacktoberfest

API responses are getting muddy

Đang mở
#132 1 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
20/100
Loại issue
Tính năng
Độ rõ ràng
Cần làm rõ
Mức độ hoạt động
Đình trệ
Công nghệ
javascript
Lĩnh vực
api

Hướng nghiên cứu

Issue không nêu tên các tệp, điểm vào hoặc bài kiểm thử. Hãy bắt đầu bằng cách xác định các trình xử lý yêu cầu API và phần xây dựng response, sau đó ghi lại các dạng response hiện có cùng các yêu cầu về khả năng tương thích ngược; hoàn tất nghĩa là đã thống nhất thiết kế lựa chọn response có độ bao phủ cho các dạng được đề xuất.

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

Mô tả

enhancement

We need to consider better requests to offer the cleaner responses. We've made some compromises for backward compatibility but not in a generic way. It may be good to find that way. One option would be something like ?responseContainer=new_obj on the request so that we can default to returning the updated document or an array of them or put them inside { queryResults: [ results ] } if the consuming application needs/prefers them that way.

This would mean we would only have to modify old requests to add the parameter and we would be accommodating future requests like metadata if someone wants back the original query, count of results, time to find, most recent, ordering, etc.

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

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/rerum_server_nodejs

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

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.