Question

We recently started providing a data extract to clients via an XML. We have a schema (XSD) that defines the structure of this XML. I would like to include the documentation of the elements and attributes in the schema itself. The only thing I am finding is the very cumbersome “annotation” and “documentation” tags.

So you take something as simple and easy to read as this:

<xs:element name="TransactionType" type="xs:string"  />

And end up with this ugly mess:

<xs:element name="TransactionType" type="xs:string">
    <xs:annotation>
        <xs:documentation>
            Type of transaction
        </xs:documentation>
    </xs:annotation>
</xs:element>

Is there anything better? Say something like this:

<xs:element name="TransactionType" type="xs:string" description="Type of transaction"  />

PS: We already provided this extract as a simple fixed length file and as a CSV. One client requested an XML and we now have a second client wanting to use the XML. I got asked for documentation. The first client for whom we originally developed the XML version just wanted an XSD. Hence my hope to just send the second client one document — the XSD with simple annotations describing the elements.

Answer 1

No, there is not. <xs:annotation><xs:documentation> is all there is.