[jboss-jira] [JBoss JIRA] (WFWIP-133) wildfly-microprofile-metrics-smallrye_1_0.xsd should provide some documentation for allowed attributes

Jeff Mesnil (Jira) issues at jboss.org
Mon Nov 5 07:45:00 EST 2018


    [ https://issues.jboss.org/browse/WFWIP-133?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=13656528#comment-13656528 ] 

Jeff Mesnil commented on WFWIP-133:
-----------------------------------

I'm rather -1 on this one.

WildFly management model is thoroughly described both in the CLI and on http://wildscribe.github.io (including metadata).

As long as the XSD maps quite simply to the management model, I prefer to avoid documentation duplication (and the maintenance cost associated to it).

> wildfly-microprofile-metrics-smallrye_1_0.xsd should provide some documentation for allowed attributes
> ------------------------------------------------------------------------------------------------------
>
>                 Key: WFWIP-133
>                 URL: https://issues.jboss.org/browse/WFWIP-133
>             Project: WildFly WIP
>          Issue Type: Bug
>          Components: MP Metrics
>            Reporter: Rostislav Svoboda
>            Assignee: Jeff Mesnil
>            Priority: Major
>
> wildfly-microprofile-metrics-smallrye_1_0.xsd should provide some documentation for allowed attributes
> CLI provides description for attributes via {{/subsystem=microprofile-metrics-smallrye:read-resource-description}}.
> Same information should be present in wildfly-microprofile-metrics-smallrye_1_0.xsd via {{<xs:annotation>}} and {{<xs:documentation>}}



--
This message was sent by Atlassian Jira
(v7.12.1#712002)


More information about the jboss-jira mailing list