[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=12715466#comment-12715466 ] 

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

I had debate with Emanuel on this topic and we came to conclusion that best way to address this would be not to over complicate things.
Aka we do not need to provide "text" info on why this deprecated in DMR as this would just cause us problems with localization.
Instead of wording on why and how this was deprecated we could just provide "replacement" property that would tell us what to use instead.
Also we do not need info on when this operation was deprecated as current state is deprecated as in "this is the version when it is/was deprecated"
more important information would be when this resource would be removed.
so my current idea about meta data would be something like this: (example for attribute)
{noformat}
name: old-attribute
type: OBJECT
deprecated: true
deprecated-replacement: new-attribute
deprecated-removed: 1.3.0 (or if we go with version of AS, 7.2.0.Final)
{noformat}

wdyt?
                
> 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