ansible/awx

Limit fields in API output

Open

#508 opened on Oct 26, 2017

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

Repository metrics

Stars
 (13,071 stars)
PR merge metrics
 (Avg merge 24d 6h) (30 merged PRs in 30d)

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

Research direction
Examine the existing API serializers and query parameter handling. Implement a `fields` query parameter that dynamically filters serializer output fields.
Tech stack
pythonrest api
Domain
api
Issue type
Feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
Git
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
75