[DOCU-3197] Clarification on formats supported for nodes/properties APIs Created: 21/Dec/23  Updated: 21/Dec/23

Status: Open
Project: Documentation
Component/s: None
Affects Version/s: None
Fix Version/s: None

Type: Improvement Priority: Neutral
Reporter: Antony Hutchison Assignee: Unassigned
Resolution: Unresolved Votes: 0
Labels: None
Remaining Estimate: Not Specified
Time Spent: Not Specified
Original Estimate: Not Specified

Documentation page URL: https://docs.magnolia-cms.com/product-docs/6.2/Developing/API/Nodes-and-properties-APIs/Nodes-API.html
Reporter Name: Antony Hutchison
Email: antony@hutchisontechnical.co.uk

 Description   

The examples give JSON output as default, which is useful in many cases. Although undocumented, application/xml also works. This is great for application development for content-management purposes rather than the front-end centric JSON format.

However I do have a user-case which ideally I would use YAML, but this isn't supported. I tried application/yaml and application/x-yaml

Could we have a list of supported formats on this page please? I'm developing tools using these APIs which benefit from non-JSON formats but I'd like some assurances that I'm not relying on an unsupported feature that may disappear at a later date.

If XML is unsupported it should be clear on this page. If there are other formats available a list of the correct mime types would be beneficial. 


Generated at Mon Feb 12 01:33:58 CET 2024 using Jira 9.4.2#940002-sha1:46d1a51de284217efdcb32434eab47a99af2938b.