[jboss-jira] [JBoss JIRA] (WFCORE-1974) Inconsistency in resource description

[Radim Hatlapatka (JIRA)]

     [ https://issues.jboss.org/browse/WFCORE-1974?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]

Radim Hatlapatka updated WFCORE-1974:
-------------------------------------
    Priority: Trivial  (was: Minor)


> Inconsistency in resource description 
> --------------------------------------
>
>                 Key: WFCORE-1974
>                 URL: https://issues.jboss.org/browse/WFCORE-1974
>             Project: WildFly Core
>          Issue Type: Bug
>          Components: Domain Management
>            Reporter: Radim Hatlapatka
>            Assignee: Brian Stansberry
>            Priority: Trivial
>              Labels: user_experience
>
> The description format is inconsistent in relation to starting with camel case and in relation to ending with full stop. This should be ideally consistent.
> There are some inconsistencies noted with Undertow subsystem that I've noted, still the issue is general:
> # Start with uppercase/lowercase >>"description" => "*_+enables+_* x-for ... "<< {noformat}"proxy-address-forwarding" => {
>                 "type" => BOOLEAN,
>                 "description" => "enables x-forwarded-host and similar headers and set a remote ip address and hostname",
>                 "expressions-allowed" => true,
>                 "nillable" => true,
>                 "default" => false,
>                 "access-type" => "read-write",
>                 "storage" => "configuration",
>                 "restart-required" => "resource-services"
> {noformat} vs {noformat}"url-charset" => {
>                 "type" => STRING,
>                 "description" => "URL charset",
>                 "expressions-allowed" => true,
>                 "nillable" => true,
>                 "default" => "UTF-8",
>                 "min-length" => 1L,
>                 "max-length" => 2147483647L,
>                 "access-type" => "read-write",
>                 "storage" => "configuration",
>                 "restart-required" => "no-services"{noformat}
> # End with dot/no dot {noformat}"url-charset" => {
>                 "type" => STRING,
>                 "description" => "URL charset",
>                 "expressions-allowed" => true,
>                 "nillable" => true,
>                 "default" => "UTF-8",
>                 "min-length" => 1L,
>                 "max-length" => 2147483647L,
>                 "access-type" => "read-write",
>                 "storage" => "configuration",
>                 "restart-required" => "no-services"{noformat} vs {noformat}"receive-buffer" => {
>                 "type" => INT,
>                 "description" => "The receive buffer size, in bytes.",
>                 "expressions-allowed" => true,
>                 "nillable" => true,
>                 "access-type" => "read-write",
>                 "storage" => "configuration",
>                 "restart-required" => "no-services"{noformat}
>  



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