• Type: Improvement
• Resolution: Fixed
• Priority: Minor
• Component/s: matrix-auth-plugin
• Labels:

  None

[JENKINS-68581] Improve AuthorizationContainer.add() method description

Alexandre Gomes created issue - 2022-05-19 06:26

Kalle Niemitalo made changes - 2022-05-19 07:04

Description

Original: The new form of AuthorizationContainer.add() has a description that can be confusing. It states: ?? Works like add(Permission, PermissionEntry) but takes both parameters from a single string of the form PERMISSION_ID:sid (legacy format, implicit 'EITHER' type) or type:PERMISSION_ID:sid (new since 3.0).?? That might lead users to think that: {code:java} add(Jenkins.ADMINISTER, "username"){code} would translate directly as: {code:java} add("Jenkins.ADMINISTER:username"){code}  when the correct form is: {code:java} add("hudson.model.Hudson.Administer:username"){noformat}   reference: [https://github.com/jenkinsci/matrix-auth-plugin/blob/master/src/main/java/org/jenkinsci/plugins/matrixauth/AuthorizationContainer.java#L175|https://github.com/jenkinsci/matrix-auth-plugin/blob/master/src/main/java/org/jenkinsci/plugins/matrixauth/AuthorizationContainer.java#L175]

New: The new form of AuthorizationContainer.add() has a description that can be confusing. It states: ?? Works like add(Permission, PermissionEntry) but takes both parameters from a single string of the form PERMISSION_ID:sid (legacy format, implicit 'EITHER' type) or type:PERMISSION_ID:sid (new since 3.0).?? That might lead users to think that: {code:java} add(Jenkins.ADMINISTER, "username"){code} would translate directly as: {code:java} add("Jenkins.ADMINISTER:username"){code}  when the correct form is: {code:java} add("hudson.model.Hudson.Administer:username"){code}   reference: [https://github.com/jenkinsci/matrix-auth-plugin/blob/master/src/main/java/org/jenkinsci/plugins/matrixauth/AuthorizationContainer.java#L175|https://github.com/jenkinsci/matrix-auth-plugin/blob/master/src/main/java/org/jenkinsci/plugins/matrixauth/AuthorizationContainer.java#L175]

Daniel Beck made changes - 2022-05-19 07:21

Issue Type

Original: New Feature [ 2 ]

New: Improvement [ 4 ]

Daniel Beck made changes - 2022-07-15 11:54

Status

Original: Open [ 1 ]

New: In Progress [ 3 ]

Daniel Beck made changes - 2022-07-15 11:54

Status

Original: In Progress [ 3 ]

New: In Review [ 10005 ]

Daniel Beck made changes - 2022-07-15 11:54

Remote Link

New: This issue links to "PR#128 (Web Link)" [ 27966 ]

Daniel Beck made changes - 2022-12-08 16:24

Released As		New: matrix-auth-3.1.6
Resolution		New: Fixed [ 1 ]
Status	Original: In Review [ 10005 ]	New: Closed [ 6 ]