ansible/awx

User auth field not documented in OPTIONS

Open

#2,301 opened on Sep 21, 2018

View on GitHub
 (3 comments) (0 reactions) (0 assignees)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

Contributor guide

Tech stack
pythondjangorest api
Domain
apibackendauthentication
Issue type
bug
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-3 hours
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
Django REST frameworkUnderstanding of OPTIONS methodUser model fields
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
75
Research direction
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.