ansible/awx

Limit fields in API output

Open

#508 ouverte le 26 oct. 2017

Voir sur GitHub
 (1 commentaire) (6 réactions) (0 assignés)Python (3 333 forks)batch import
component:apihelp wantedtype:enhancement

Métriques du dépôt

Stars
 (13 071 stars)
Métriques de merge PR
 (Merge moyen 24j 6h) (30 PRs mergées en 30 j)

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.

Guide contributeur

Direction de recherche
Examinez les sérialiseurs API existants et la gestion des paramètres de requête. Implémentez un paramètre de requête `fields` qui filtre dynamiquement les champs de sortie du sérialiseur.
Stack technique
pythonrest api
Domaine
api
Type d'issue
Fonctionnalité
DifficultéDifficulté estimée pour un nouveau contributeur, de 1 pour un très petit changement à 5 pour un travail expert.
2
Temps estiméFourchette de temps approximative pour investiguer, implémenter, tester et préparer une pull request.
1-3 heures
Statut d'activitéDisponibilité apparente de l'issue : fraîche, active, ancienne, bloquée ou en attente d'un mainteneur.
Active
ClartéClarté avec laquelle l'issue explique le changement attendu, les critères d'acceptation et la prochaine étape.
Claire
Prérequis
Git
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
75