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

feature request: Make GET channels/{target}/messages use request body instead of query parameters

Đang mở
#28 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
35/100
Loại issue
Tính năng
Độ rõ ràng
Khá rõ ràng
Mức độ hoạt động
Đình trệ
Công nghệ
openapi, typescript
Lĩnh vực
api, backend-api-design

Hướng nghiên cứu

Bắt đầu với các định nghĩa API được liên kết của Search for Messages và Fetch Messages, so sánh các tham số request và schema body của chúng. Theo dõi nơi các định nghĩa endpoint này cung cấp dữ liệu cho TypeScript typings và OpenAPI v3 generator; hoàn tất khi cả hai endpoint sử dụng cùng một hình dạng JSON request-body và các breaking client types tạo ra nhất quán với nhau.

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

Mô tả

enhancement
What do you want to see?

At the moment, Search for Messages (POST channels/{target}/search) utilizes nearly identical parameters to Fetch Messages (GET channels/{target}/messages), but the former uses a JSON request body whereas the latter uses query parameters, which in my personal opinion is a worse way to build requests especially with as many parameters as the methods allow.

Would it be possible to make both endpoints use the same request body type (specifically a JSON request body instead of query parameters) for consistency? This would obviously be a breaking change for clients and API wrappers which depend on this functionality, but I think it would be better to get that over with sooner rather than later.

Ngôn ngữ chính
TypeScript
Star
42
Fork
34
Không có pull request nào được merge trong 30 ngày

Hướng dẫn đóng góp

Mở hướng dẫn đóng góp

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 stoatchat/javascript-client-api

Tất cả issue của stoatchat/javascript-client-api

Issue tương tự

Thêm issue về TypeScript

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.