[jboss-jira] [JBoss JIRA] (AS7-5112) Add deprecation information to management API metadata

[Tomaz Cerar (JIRA)]

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

Tomaz Cerar commented on AS7-5112:
----------------------------------

Current impl looks like this:
example is from messaging subsystem CoreAddressDefinition
mgmt code:
{code:java}
private static final AttributeDefinition ROLES = ObjectListAttributeDefinition.Builder.of(CommonAttributes.ROLES_ATTR_NAME, SecurityRoleDefinition.getObjectTypeAttributeDefinition())
            .setFlags(AttributeAccess.Flag.STORAGE_RUNTIME)
            .setDeprecated(ModelVersion.create(1,2,0))
            .build();
{code}
dmr output
{noformat}
...
"roles" => {
                    "type" => LIST,
                    "description" => "Deprecated (use the role children instead). A list of the security roles (name and permissions) associated with the address.",
                    "expressions-allowed" => false,
                    "nillable" => false,
                    "deprecated" => {
                        "since" => "1.2.0",
                        "reason" => "Attribute is deprecated in favor of xyz (todo real reason)"
                    },
                    "value-type" => {
...
{noformat}

it automatically looks for "name of attribute".deprecated
in this case:

{noformat}roles.deprecated=Attribute is deprecated in favor of xyz (todo real reason){noformat}
                
> Add deprecation information to management API metadata
> ------------------------------------------------------
>
>                 Key: AS7-5112
>                 URL: https://issues.jboss.org/browse/AS7-5112
>             Project: Application Server 7
>          Issue Type: Feature Request
>          Components: Domain Management
>            Reporter: Brian Stansberry
>            Assignee: Tomaz Cerar
>             Fix For: 7.3.0.Alpha1
>
>
> Add metadata describing that we have deprecated:
> 1) Resources
> 2) Attributes
> 3) Operations
> 4) Operation parameters
> We'll need to sort out exactly what info to provide. We can declare in what management API version an item was deprecated, and provide some localized text explaining. More problematic would be info on what "version" the item will be removed in (outside of vague wording in the description text). Probably including such info would be a mistake; prone to error.

--
This message is automatically generated by JIRA.
If you think it was sent incorrectly, please contact your JIRA administrators
For more information on JIRA, see: http://www.atlassian.com/software/jira