Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Issue #418: Change the parameter name on the URL #429

Merged
merged 2 commits into from
Jun 26, 2024
Merged

Issue #418: Change the parameter name on the URL #429

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
cd26fed
Issue #418: Change the parameter name on the URL
RomanMagnoli Jun 25, 2024
4220a87
Issue #418: Fix 'distinct' parameter to avoid NPE
RomanMagnoli Jun 26, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions modules_core/com.smf.securewebservices/web/com.smf.securewebservices/doc/doc.yaml
View file
Open in desktop
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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}:

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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}:

Original file line number Diff line number Diff line change
Expand Up @@ -98,7 +98,7 @@ paths:
$ref: "#/components/schemas/LogResp"
401:
description: No auth.
/sws/com.smf.securewebservices.obRest/{modelName}:
/sws/com.smf.securewebservices.obRest/{_entityName}:
get:
summary: List records
security:
Expand Down Expand Up @@ -229,7 +229,7 @@ paths:
application/json:
schema:
$ref: "#/components/schemas/Error"
/sws/com.smf.securewebservices.obRest/{modelName}/{recordID}:
/sws/com.smf.securewebservices.obRest/{_entityName}/{recordID}:
get:
summary: Get a record by ID
security:
Expand Down
Loading