ansible/awx

Limit fields in API output

Open

#508 opened on Oct 26, 2017

View on GitHub
 (1 comment) (6 reactions) (0 assignees)Python (13,071 stars) (3,333 forks)batch import
component:apihelp wantedtype:enhancement

Description

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.

Contributor guide

Tech stack
pythonrest api
Domain
apibackend
Issue type
feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-2 days
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
Basic understanding of Django REST frameworkFamiliarity with AWX API endpoints
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
45
Research direction
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/'.