fix: Fix missing response types in Swagger API endpoints

[lan-yonghui]

Refs #7607

[f2c-ci-robot]

Adding the "do-not-merge/release-note-label-needed" label because no release-note block was detected, please follow our release note process to remove it.

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository.

[wanghe-fit2cloud]

The code changes look generally appropriate and follow standard API documentation conventions, but there are some slight inconsistencies:

1. Status Code Mismatch: The @Success annotations for methods that return arrays or objects (like List website names, Get site permissions, etc.) should use {array} instead of just string. For instance:

   // @Success 200 {array} response.WebsiteOption

2. Response Objects: Some responses might not explicitly define their response structure using types like response.NginxRewriteRes, response.WebsiteProxyConfig etc. While it's generally okay to omit defining a specific type if it's straightforward and clear what data is expected, it can be beneficial to define custom structs to ensure consistency and clarity.

3. File Info Object: Replace {object} with {object} response.FileInfo in the /websites/default/html/{type} method since FileInfo represents file information which needs a more precise response definition.

These adjustments will improve readability and maintainability of your API endpoint definitions.

[wanghe-fit2cloud]

1. The first line of the ListFiles function should be changed to use a struct literal instead of casting.

files, err := fileService.GetFiles(req)

2.helper.ErrorWithDetail(c, constant.CodeErrInternalServer, constant.ErrTypeInternalServer, err) can be simplified to helper.FailWithDetail(c, "internal server error", err)

err = fileService.GetFileList(req)
if err != nil {
        helper.FailWithDetail(c, "failed to get file list", err)
        return
}

helper.SuccessWithData(c, fileList)

3. The change from using constant.ErrTypeInternalServer to just stating "internal server error" is more explicit and cleaner.

4. In the Keys function, if there are multiple keys that need to be returned, it might be better to have those values stored in an array or map before passing them to SuccessWithData.

In summary, these changes streamline some boilerplate code such as logging errors or formatting responses and make them easier to read and maintain.

[wanghe-fit2cloud]

There are no irregularities or significant issues with this Go/Gin API code snippet based on the provided knowledge cutoff of September 1, 2021. However, here are some minor observations:

1. Comment Update: The comment block for /host/tool/supervisor/process should reflect that it serves "Supervisor process config" rather than just being true.

// @Summary Get Supervisor process config
// @Desc        Retrieve the configuration details for Supervisor processes.

This change ensures clarity about what this endpoint actually accomplishes.

2. Response Type for /host/tool/log:

   • Currently, /host/tool/log uses "logContent" in its @Success tag, which is not consistent. It might be more appropriate to return the actual log content, not just a placeholder string. For example:

     ["error", "warning", "info"]

3. Consistency Across Endpoints: Ensure that all endpoints use uniform JSON responses unless they have specific data formats. This can make them easier to consume across different client applications.

4. Logging: Ensure proper logging throughout the endpoints if required for debugging or monitoring purposes.

5. Error Handling: Consider implementing better error handling practices, especially around invalid input data or unexpected errors during API operations.

These points, while not breaking any fundamental aspects of the code, could improve readability, consistency, and maintainability.

[sonarqubecloud]

Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarQube Cloud

[wanghe-fit2cloud]

/lgtm

[wanghe-fit2cloud]

/approve

[f2c-ci-robot]

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: wanghe-fit2cloud

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Needs approval from an approver in each of these files:

• OWNERS [wanghe-fit2cloud]

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment