Refactoring envelope of successful responses and its client contract

未關閉 適合新手
#256 0 則留言 0 個 reaction 已指派 0 人 在 GitHub 檢視

維護者通常 1 天內回覆

還沒有人認領這個 Issue。

評估

難度
2/5
預估耗時
1-3 小時
新手友好度
62/100
Issue 類型
重構
描述清晰度
基本清楚
活躍度
活躍
技術堆疊
python
領域
api, backend

研究方向

從 src/utils/utils.py 中的成功回應建構器著手,檢查其呼叫端和測試,以了解用戶端預期哪些回應欄位。統一更新資料、分頁和彙總的成功回應封裝,然後執行相關測試。完成標準是從回應本文中移除多餘欄位,並在測試中反映用戶端契約。

由索引模型根據 Issue 內容生成。

描述

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?"

主要語言
Python
星號
4
分支
0
平均合併
3 天 12 小時
30 天內合併 PR
10

環境準備

  • 提供 Dockerfile 或 Docker Compose 檔案
  • 有 Pull Request 範本
  • 沒有貢獻指南

從這裡開始

  1. 先讀完整個 Issue,再讀專案的貢獻指南。
  2. 在 Issue 下留言說明你要接手 —— 這能避免兩個人做同樣的事。
  3. Fork 儲存庫,在一個分支上完成修改。
  4. 送出 Pull Request,並在描述裡引用這個 Issue 編號。

AbsaOSS/EventGate 的其他 Issue

查看 AbsaOSS/EventGate 的全部 Issue

相似的 Issue

更多 Python Issue

把新 issue 寄到你的電子郵件信箱

精選適合新手參與的 GitHub issue 摘要。