Why should the display name match the technical name of the policy?

[karsten-wagner]

I am referring to rule apigee-xml:PolicyDisplayNameCheck. It generates messages like `It is recommended that the policy name attribute (AM-DummyResponse) match the display name of the policy (Creates "OK" Response Text).

Would you consider to drop this rule? Based on the Apigee Naming Conventions, the Display Name should actually tell a human what this policy is all about.
See: https://docs.apigee.com/api-platform/fundamentals/best-practices-api-proxy-design-and-development#developmentstandards-namingconventions
"DisplayName should accurately describe the policy’s function to someone who has never worked with that API proxy before."

Requesting to have the display name to be the same as the technical name (which in turn has to be the same as the file name), is violating that Apigee convention in my point of view...
Btw, same issue exists in the "apigeelint" tool, which seems to have been the origin idea for this SonarQube plugin...

[karsten-wagner]

Just as a reference - I raised the same request on the apigeelint tool: apigee/apigeelint#154

[ntiss]

Hi @karsten-wagner
You're right with this question... and I don't know the exact reason for this rule.
Just be aware that this Sonar plugin is initially based on all rules of the apigeelint with the same ID, plus some rules useful for my company (IDs upper than 500). This is why you find the same rule PO008 with no clear explaination.

Before considering to droping this rule, I suggest to wait for an answer to apigee/apigeelint#154 coming from people near Apigee team. They should provide a clear advice.

Fortunately, in using this Sonar plugin, you are free to disable any rule (so this one) by creating your custom SonarWay profile.

[karsten-wagner]

Thank you, @ntiss - deactivating the rule is the way we currently go. I am looking forward to a response from the Apigee team as well...