Represent XML tag with multiple namespaces

[nickkpiccoli]

Hi, I need to represent a Soap request that has the Envelope like this "<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xmlns:other = "http:example..">".

In the oas actually the request look like this:

      "createEnvelopeRequest": {
        "type": "object",
        "required": [
          "soap:Body"
        ],
        "properties": {
          "soap:Body": {
            "type": "object",
            "required": [
              "CreateAuthReq"
            ],
            "properties": {
              "CreateAuthReq": {
                "$ref": "#/components/schemas/createRequest"
              }
            },
            "xml": {
              "name": "Body",
              "prefix": "soap"
            }
          }
        },
        "xml": {
          "name": "Envelope",
          "namespace": "http://schemas.xmlsoap.org/soap/envelope/",
          "prefix": "soap"
        }
      },

How can I modify this to have multiple namespace/attributes(xmlns:other) in the soap:Envelope tag?

[handrews]

@nickkpiccoli I believe the issue here is not multiple attributes (which can be done), but multiple namespaces, as the namespace field of the XML Object only allows defining one namespace per XML node.

@ralfhandl any ideas here? I don't know enough about XML Namespaces to understand why the namespace field was done this way or how it might be possible to work around it.

[nickkpiccoli]

@handrews oh yes sorry, I meant multiple namespaces, I got a bit mixed up while replying 😅 I’ll wait, thanks!

[ralfhandl]

The workaround is to declare the other prefix on the nested node (element or attribute) that needs it. Pulling an XML namespace declaration up to an enclosing XML element or the XML document root node is just a convenience/shorthand. From an XML perspective these are equivalent:

<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xmlns:other="http:example..">
  <other:Elem>
    …
  </other:Elem>
</soap:Envelope>

and

<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <other:Elem xmlns:other="http:example..">
    …
  </other:Elem>
</soap:Envelope>

With OpenAPI 3.2 each element and attribute can be represented as a node with the corresponding nodeType and its specific namespace.

[handrews]

Thank, @ralfhandl

@nickkpiccoli I remember what else this reminded me of, which is issue #1652 about global hints for setting things like global namespaces. We ended up recommending the new Overlay Specification as a solution for automating adding namespaces all over a bunch of different XML Objects.

If/when we get around to a 4.0 release with breaking changes, a new syntax to allow more flexibility with namespaces would probably be worth considering.

[nickkpiccoli]

Thank you all