Skip to content

OAS 3.2: XML #401

@philsturgeon

Description

@philsturgeon

Improvements for APIs using XML as a content format

  • New nodeType field allows mapping schemas to common XML node types: element, attribute, text, cdata, or none.
    • attribute: true is now deprecated in favor of nodeType: attribute.
    • wrapped: true is now deprecated in favor of nodeType: element (as nodeType defaults to none for arrays to preserve compatibility).
  • The xml keyword can be used in any Schema Object.
  • XML namespaces can be IRIs (rather than URIs).
  • Explanation and examples for many use cases including handling null, handling arrays, replacing the name, and handling ordered elements.
  • Clarify that the root schema of an XML Object should use the component name.

Metadata

Metadata

Assignees

No one assigned

    Labels

    contentIssue/change about the text content of the docs site

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions