macadmins / macadmins/jamf-pro-sdk-python

[Feature Request] Option to parse XML from Classic API endpoints

Aperta
#33 4 commenti 0 reazioni 1 assegnatario Vedi su GitHub

@brysontyrrell ci sta già lavorando.

Dal 28/11/2023.

enhancement feedback
Lingua principale
Python
Stelle
69
Fork
16
Metriche di merge delle PR
Nessuna PR unita negli ultimi 30g

Descrizione

Currently, JSON responses are requested from the Classic API and can be parsed with the .json() method:

response = api.classic_api_request("GET", "accounts/userid/257")
user_info = response.json()

However, there's no equivalent option for parsing XML responses if the headers are overridden to request XML:

response = api.classic_api_request("GET", "accounts/userid/257", override_headers={"Accept": "application/xml"})
user_info = response.xml()  # this doesn't exist

Some orgs may benefit from the ability to choose between XML and JSON responses. One use case would be working around Jamf product issues that affect the accuracy of information returned via one format — like PI104345: /accounts endpoint giving different results when searching by userid vs. username.

Proposal

The SDK could provide an .xml() method similar to the existing .json() method that converts XML responses to dictionary form, possibly leveraging a module like xmltodict to do the work behind the scenes.

Alternatively, the response could contain a .data attribute that provides the relevant information in structured data (lists or dicts) regardless of what serialization format was requested — a parsed equivalent to .text. This attribute could replace both .json() and .xml() functionalities.

Thanks for considering.

Guida per i contributori

Nessuna guida per i contributori indicizzata per questo repository

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Valutazione

Questa issue non è ancora stata valutata.

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.