ansible/awx

User auth field not documented in OPTIONS

Open

#2 301 ouverte le 21 sept. 2018

Voir sur GitHub
 (3 commentaires) (0 réactions) (0 assignés)Python (13 071 stars) (3 333 forks)batch import
Hacktoberfestcomponent:apigood first issuehelp wantedtype:enhancement

Description

ISSUE TYPE
  • Bug Report
COMPONENT NAME
  • API
SUMMARY

The user serializer provides the auth field but it is not present in OPTIONS

ENVIRONMENT
  • AWX version: 1.0.8
  • AWX install method: openshift, minishift, docker on linux, docker for mac, boot2docker
  • Ansible version: X.Y.Z
  • Operating System:
  • Web Browser:
STEPS TO REPRODUCE

GET /api/v2/users/

OPTIONS /api/v2/users/

EXPECTED RESULTS

Fields match, GET vs. OPTIONS

ACTUAL RESULTS

auth field returned but not in options.

Also, the field is not present in the access_list endpoints, and I would argue that it should be.

ADDITIONAL INFORMATION

Guide contributeur

Stack technique
pythondjangorest api
Domaine
apibackendauthentication
Type d'issue
bug
DifficultéDifficulté estimée pour un nouveau contributeur, de 1 pour un très petit changement à 5 pour un travail expert.
3
Temps estiméFourchette de temps approximative pour investiguer, implémenter, tester et préparer une pull request.
1-3 hours
Statut d'activitéDisponibilité apparente de l'issue : fraîche, active, ancienne, bloquée ou en attente d'un mainteneur.
stale
ClartéClarté avec laquelle l'issue explique le changement attendu, les critères d'acceptation et la prochaine étape.
clear
Prérequis
Django REST frameworkUnderstanding of OPTIONS methodUser model fields
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
75
Direction de recherche
Investigate the user serializer in awx/api/serializers.py to identify why the 'auth' field is not included in the OPTIONS response. Check if the field is defined with proper metadata or if it is dynamically added. Also review the access list endpoint views to see if the field should be added there. Refer to the Django REST framework documentation on OPTIONS and serializer metadata for guidance.