Add top level XML code generation hints

[silkentrance]

Having to always denote the same xml properties over and over again, namely the prefix and the namespace on properties and data types alike, one should instead be able to add an xml property at the top level, e.g.

xml:
  namespace: 'foo:bar:v1'
  prefix: 'fbv1'
components:
  ...

This then would act as the default for all data types and properties and also items of properties of type array.

This will make things much easier for us.

In the future, this could be extended so that one could have multiple NSURLs and associated prefixes and just reference these prefixes from xml code generation hints at the data type level or property level, e.g.

xml:
  default:
    namespace: 'foo:v1'
  fbv1:
    namespace: 'foo:bar:v1'
  fbv1add:
    namespace: 'foo:bar:v1-additions'
components:
  Foobar:
    xml:
      prefix: 'fbv1add'
  Barfoo:
    xml:
      prefix: 'fbv1'
  Foo:
    // uses default namespace

The code generator could then look up the prefix from the top level xml code generation hints and fill in the gaps.

[lornajane]

Could this use case now be served by use of an Overlay?

[handrews]

@lornajane I think that would be a good use of Overlays. I was looking at this a few days ago and realized that trying to solve it now would add another implicit lookup like what we do for discriminator and security requirements, and those have been problematic. An overlay would avoid that problem- I assume it would work by just selecting all XML Objects and adding the namespace and prefix fields, or selecting all XML Objects with a particular prefix field and adding namespace?

[handrews]

@silkentrance do overlays handle this sufficiently? Adding global things has come up before, but it's a bit complex with OpenAPI Descriptions that are spread across multiple files, some of which may be shared among multiple descriptions. Overlays provide more explicit control instead of adding more complex implicit lookup rules.

[silkentrance]

@handrews Overlays appear to be a good solution, though much depends on overall tooling support.