NodeBB / NodeBB/nodebb-plugin-write-api
Return data not documented
Đang mở
Chưa có ai nhận issue này.
- Ngôn ngữ chính
- JavaScript
- Star
- 136
- Fork
- 75
- Merge trung bình
- 1 phút
- Pull request đã merge (30 ngày)
- 8
Mô tả
Assuming this is a thing, I don't see any documentation for it. What data is returned for each endpoint? For example, if I create a topic, what object is returned?
Hướng dẫn đóng góp
Chưa lập chỉ mục được hướng dẫn đóng góp cho kho mã nguồn này
Bắt đầu từ đâu
- Đọc hết issue, rồi đọc hướng dẫn đóng góp của dự án.
- 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.
- Fork repository và làm thay đổi trên một nhánh.
- Mở pull request có tham chiếu số hiệu của issue.
Hướng nghiên cứu
Issue này liên quan đến các endpoint của RESTful JSON API; trước tiên hãy lập danh mục từng endpoint và kiểm tra hành vi phản hồi hiện tại của chúng. Ghi lại đối tượng được trả về cho các thao tác như tạo topic, sau đó xác minh rằng tài liệu bao quát mọi endpoint và khớp với các phản hồi đã quan sát.
Do mô hình lập chỉ mục viết ra từ nội dung của issue.
Đánh giá
- Công nghệ
- javascript
- Lĩnh vực
- api, documentation
- Loại issue
- Tài liệu
- Độ khó
- 4/5
- Thời gian dự kiến
- 3-5 ngày
- Mức độ hoạt động
- Đình trệ
- Độ rõ ràng
- Khá rõ ràng
- Mức phù hợp với người mới
- 35/100