Refactoring envelope of successful responses and its client contract

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

Maintainer thường phản hồi trong vòng 1 ngày

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

Đánh giá

Độ khó
2/5
Thời gian dự kiến
1-3 giờ
Mức phù hợp với người mới
62/100
Loại issue
Tái cấu trúc
Độ rõ ràng
Khá rõ ràng
Mức độ hoạt động
Sôi nổi
Công nghệ
python
Lĩnh vực
api, backend

Hướng nghiên cứu

Bắt đầu với các hàm tạo phản hồi thành công trong src/utils/utils.py và kiểm tra các nơi gọi chúng cùng các bài kiểm thử để xác định client mong đợi những trường phản hồi nào. Cập nhật nhất quán envelope của phản hồi thành công cho dữ liệu, phân trang và các phép tổng hợp, sau đó chạy các bài kiểm thử liên quan. Công việc hoàn tất khi các trường dư thừa được xóa khỏi phần thân phản hồi và các bài kiểm thử phản ánh hợp đồng của client.

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

Mô tả

refactoring

Summary

Revisit the envelope of successful (HTTP 200) responses from the stats lambda. Every success body currently contains two fields that duplicate the HTTP response:

{"success": true, "statusCode": 200, "data": [...], "pagination": {...}}
{"success": true, "statusCode": 200, "aggregations": {...}}
  • success: true is already implied by the 2xx status code.
  • statusCode is repeated in the body, although it is already the API Gateway statusCode.

This is built in src/utils/utils.py (success response builders for data/pagination and aggregations).

Background

Raised by @lsulak in review of PR #243: "success is quite visible from the status code, and then also status code is there twice. Is there any situation when it differentiates?"

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

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

  • Có Dockerfile hoặc tệp Docker Compose
  • Có mẫu pull request
  • Không có 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 AbsaOSS/EventGate

Tất cả issue của AbsaOSS/EventGate

Issue tương tự

Thêm issue về Python

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.