macadmins / macadmins/jamf-pro-sdk-python

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

Offen
#33 4 Kommentare 0 Reaktionen 1 zugewiesene Person Auf GitHub ansehen

@brysontyrrell arbeitet bereits daran.

Seit 28.11.2023.

enhancement feedback
Vorherrschende Sprache
Python
Sterne
69
Forks
16
PR-Merge-Kennzahlen
Keine gemergten PRs in 30 T.

Beschreibung

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.

Beitragsleitfaden

Für dieses Repository ist kein Beitragsleitfaden indexiert

Erste Schritte

  1. Lies das ganze Issue und danach den Beitragsleitfaden des Projekts.
  2. Schreib ins Issue, dass du es übernimmst — das erspart doppelte Arbeit.
  3. Forke das Repository und arbeite in einem Branch.
  4. Öffne einen Pull Request, der die Issue-Nummer nennt.

Bewertung

Dieses Issue wurde noch nicht bewertet.

Neue Issues direkt in Ihr Postfach

Eine kurze Übersicht über anfängerfreundliche GitHub-Issues.