open-ug/conveyor

AI Summary: Integrate Swagger API documentation into an existing Fiber API using the `swaggo/swag` and `swaggo/fiber-swagger` libraries. This involves adding Swagger annotations to at least one existing endpoint, generating documentation using `swag init`, and configuring a route (e.g., `/swagger`) to serve the Swagger UI. The README should be updated with installation and usage instructions.

AI Summary: The task involves improving the Conveyor CI client library by adding HTTP status code validation before unmarshalling responses in `pkg/client/resource.go`. This requires modifying existing functions to check for errors using `resp.IsError()` or `resp.StatusCode()`, returning informative error messages if necessary, and ensuring all tests pass.

AI Summary: Improve the error handling in the `pkg/client/resource.go` file of the Conveyor CI project by replacing `fmt.Println` error logging with proper error wrapping using `fmt.Errorf` or `errors.Join`, adding context to the errors for better debugging, and ensuring all tests still pass.

AI Summary: Refactor the `pkg/client/resource.go` file in the Conveyor CI project to eliminate redundant code for JSON marshaling, Resty requests, and JSON unmarshaling. This involves creating a helper function to handle these common operations and updating existing functions to use the helper. Thorough testing is required to ensure functionality remains unchanged.

AI Summary: Refactor the `pkg/client/resource.go` file in the Conveyor CI project to reuse a single Resty HTTP client instance instead of creating a new one for each function call. This involves modifying the `Client` struct, updating all functions to use the shared client, removing redundant header settings, and ensuring all tests pass.

AI Summary: Rename parameters in the `pkg/client/resource.go` file of the Conveyor CI project to improve code readability. Specifically, change non-descriptive parameter names like `app` to more descriptive names such as `resource` or `definition` based on the context. This involves updating function parameters, internal references, and running tests to ensure functionality remains intact.

AI Summary: Fix a typo in the parameter name `resouce_definition` to `resource_definition` within the `GetResource` function located in `pkg/client/resource.go` of the Conveyor CI project. This involves updating the function signature, internal references (if any), running tests, and potentially updating documentation.