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/'.