Details
-
Bug
-
Resolution: Won't Do
-
Trivial
-
None
-
7.1.0.DR7
-
None
-
User Experience
Description
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 ... "<<
"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"
vs
"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"
- End with dot/no dot
"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"
vs
"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"
Attachments
Issue Links
- is cloned by
-
WFCORE-1974 Inconsistency in resource description
- Resolved