Red Hat Bugzilla – Bug 1019069
Messaging XSD is missing description of attributes
Last modified: 2014-06-29 18:25:55 EDT
Description of problem:
Most of the elements in jboss-as-messaging_1_3.xsd is missing description.
Elements should have description.
The documentation reference for the messaging subsystem is the :read-resource-description management operation.
The XSD is purely informational and the elements are described only when they differ from the :read-resource-description model or if they are specific to the XSD schema
This is based on feedback from people who attended EAP 6 admin course. They complained about missing description of those attributes. Basically it was one of few sources from where they could get correct information.
I agree with you that it's described in CLI. But this argument was denied because it's hard to find it. Also if EAP 6 server can't be started they could not get to this information. (There were some other complains about bad documentation we have for EAP 6).
PR for upstream https://github.com/wildfly/wildfly/pull/5911
Thanks Jeff! I've checked jboss-as-messaging_1_4.xsd in EAP 6.3.0.DR1 and description for elements are there.
Is it intentional to have it in jboss-as-messaging_1_4.xsd which was already released in EAP 6.2.0.GA and not to create new version jboss-as-messaging_1_5.xsd for EAP 6.3.0.x?
Yes, that's on purpose: I did not want to create a new 1.5 schema just to add documentation annotations.
if EAP 6.3 does not require any structural changes to its XML schema, 1.4 XSD will be used for it. Otherwise, a 1.5 schema with *structural* changes will be created from the 1.4 XSD and get the documentation annotations too.
Ok, setting bz as verified.