[jboss-jira] [JBoss JIRA] (WFLY-7669) Misleading description of identity-realm

[Jan Tymel (JIRA)]

Jan Tymel created WFLY-7669:
-------------------------------

             Summary: Misleading description of identity-realm
                 Key: WFLY-7669
                 URL: https://issues.jboss.org/browse/WFLY-7669
             Project: WildFly
          Issue Type: Bug
          Components: Security
            Reporter: Jan Tymel
            Assignee: Darran Lofthouse


There is a misleading description of {{identity-realm}} in DMR [1]. It says _"A security realm definition where identities are represented in the management model."_ whereas an XSD documentation says _"Realm definition for a realm which contains a single pre-defined identity."_.
In general, the XSD description looks clearer to me. Moreover, the {{identities}} word may be misleading since {{identity-realm}}'s purpose is to _"to store one identity, with one attribute and no credential"_ [3]. Thus I would suggest to also change the description of {{attribute-values}} from 
_"The values associated with the identities attribute."_ to something like _"The values associated with the identity attributes."_

Suggestions for improvement:
* Change description {{identity-realm}} according to XSD
* Change description of {{attribute-values}} attr (in both DMR and XSD)
* to consider: unify descriptions in XSD and DMR


[1] /subsystem=elytron/identity-realm=somerealm:read-resource-description
[2] https://github.com/wildfly-security/elytron-subsystem/blob/master/src/main/resources/schema/wildfly-elytron_1_0.xsd#L412
[3] HipChats's WildFly Elytron chat room on Nov 21



--
This message was sent by Atlassian JIRA
(v7.2.3#72005)