Issue #418: Change the parameter name on the URL

[RomanMagnoli]

EPL-1535: The URL parameter name was changed in order to match with the parameter name itself.

[etendobot]

GPT Review for doc.yaml

Review

• Estimated effort to review [1-5]: 1, because the changes are minimal and straightforward, involving only the renaming of path parameters in a YAML file.
• Score: 95

Code feedback

• File:
  modules_core/com.smf.securewebservices/web/com.smf.securewebservices/doc/doc.yaml
• Language:
  yaml
• Suggestion:
  Ensure that the new parameter name _entityName is consistently used throughout the codebase and documentation. This includes updating any references in the backend code, frontend code, and any other related documentation. [important]
• Label:
  best practice
• Existing code:

  /sws/com.smf.securewebservices.obRest/{modelName}:
  /sws/com.smf.securewebservices.obRest/{modelName}/{recordID}:

• Improved code:

  /sws/com.smf.securewebservices.obRest/{_entityName}:
  /sws/com.smf.securewebservices.obRest/{_entityName}/{recordID}:

[etendobot]

GPT Review for SecureJsonDataService.java

Review

• Estimated effort to review [1-5]: 2, because the changes are minor and involve simple refactoring using utility methods. The logic and structure of the code remain largely unchanged.
• Score: 95

Code feedback

• File:
  modules_core/com.smf.securewebservices/src/com/smf/securewebservices/service/SecureJsonDataService.java
• Language:
  java
• Suggestion:
  Using StringUtils.equals and StringUtils.lowerCase from Apache Commons Lang is a good practice for null-safe operations. However, ensure that the parameters.get method does not return null, or handle the null case explicitly to avoid potential NullPointerException. [important]
• Label:
  best practice
• Existing code:

if (StringUtils.equals("true", parameters.get(JsonConstants.SHOW_FK_DROPDOWN_UNFILTERED_PARAMETER))) {

• Improved code:

if (StringUtils.equals("true", StringUtils.defaultString(parameters.get(JsonConstants.SHOW_FK_DROPDOWN_UNFILTERED_PARAMETER)))) {

• File:
  modules_core/com.smf.securewebservices/src/com/smf/securewebservices/service/SecureJsonDataService.java
• Language:
  java
• Suggestion:
  Ensure that the parameters.get method does not return null, or handle the null case explicitly to avoid potential NullPointerException when using StringUtils.lowerCase. [important]
• Label:
  best practice
• Existing code:

final String distinctPropertyPath = StringUtils.lowerCase(parameters.get(JsonConstants.DISTINCT_PARAMETER));

• Improved code:

final String distinctPropertyPath = StringUtils.lowerCase(StringUtils.defaultString(parameters.get(JsonConstants.DISTINCT_PARAMETER)));

[etendobot]

GPT Review for doc.yaml

Review

• Estimated effort to review [1-5]: 1, because the changes are straightforward and involve minor modifications to the endpoint paths and descriptions in the YAML file.
• Score: 95

Code feedback

• File:
  modules_core/com.smf.securewebservices/web/com.smf.securewebservices/doc/doc.yaml
• Language:
  yaml
• Suggestion:
  The changes made to the endpoint paths and descriptions are clear and improve the clarity of the API documentation. However, ensure that the changes are consistently applied across all related documentation and code to avoid discrepancies. [important]
• Label:
  best practice
• Existing code:

  /sws/com.smf.securewebservices.obRest/{modelName}:
  /sws/com.smf.securewebservices.obRest/{modelName}/{recordID}:

• Improved code:

  /sws/com.smf.securewebservices.obRest/{_entityName}:
  /sws/com.smf.securewebservices.obRest/{_entityName}/{recordID}:

[sonarscanetendo]

• E Maintainability Rating on New Code (is worse than A)

Analysis Details

1 Issue

• 0 Bugs
• 0 Vulnerabilities
• 1 Code Smell

Coverage and Duplications

• 0.00% Coverage (0.00% Estimated after merge)
• 0.00% Duplicated Code (13.20% Estimated after merge)

Project ID: etendosoftware_etendo_core_AYOKvQCAuJ79WHyLB97g

View in SonarQube