ansible/awx

Limit fields in API output

Open

#508 建立於 2017年10月26日

在 GitHub 查看
 (1 留言) (6 反應) (0 負責人)Python (13,071 star) (3,333 fork)batch import
component:apihelp wantedtype:enhancement

描述

ISSUE TYPE
  • Feature Idea
COMPONENT NAME
  • API
SUMMARY

Add ability to limit fields in output for all get list requests (get projects list, get inventory list, get job templates list etc.) https://.../?fields=id,description

EXPECTED RESULTS

Will be included only id and description fields in output json.

貢獻者指南

技術棧
pythonrest api
領域
apibackend
議題類型
feature
難度面向新貢獻者的預計實作難度，1 表示很小改動，5 表示專家級工作。
3
預計時間有經驗貢獻者完成調查、實作、測試並準備 pull request 的粗略時間範圍。
1-2 days
活動狀態議題目前的可參與程度：新鮮、活躍、陳舊、阻塞或等待維護者輸入。
stale
清晰度議題是否清楚說明預期改動、驗收標準和下一步。
clear
前置要求
Basic understanding of Django REST frameworkFamiliarity with AWX API endpoints
新手友善度1-100 的估計分數，表示該議題對首次貢獻者的友善程度。
45
研究方向
Investigate how API views are structured in AWX, likely using Django REST Framework (DRF) serializers. Look at existing views for model lists (e.g., projects, inventories) and consider adding a query parameter like 'fields' to dynamically select fields. The DRF's 'fields' attribute or a custom serializer may be used. Review the issue comments for any prior attempts or maintainer guidance. Start by exploring the API view files under 'awx/api/views/' and serializers in 'awx/api/serializers/'.