Include test results in API response #684
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
There was a problem hiding this comment.
Pull Request Overview
This PR updates the [PUT] /system/connect/test endpoint to return the full explorer.TestResult instead of just a boolean, and propagates this change through the config manager, API handlers, client, and interface definitions.
- Expanded
TestConnectionto return a detailedTestResultand a success flag. - Updated logging in
settings.goto include the full result. - Modified the API endpoint and client to encode and decode the new result.
Reviewed Changes
Copilot reviewed 6 out of 6 changed files in this pull request and generated 2 comments.
Show a summary per file
| File | Description |
|---|---|
| host/settings/troubleshoot.go | Changed TestConnection signature and return values. |
| host/settings/settings.go | Logged the full TestResult in debug messages. |
| api/endpoints.go | Adjusted handler to encode the new TestResult. |
| api/client.go | Updated client TestConnection to parse the result. |
| api/api.go | Updated interface signature for TestConnection. |
| .changeset/added_endpoint_to_check_the_hosts_connectivity.md | Added changeset entry for the new endpoint. |
Comments suppressed due to low confidence (1)
host/settings/troubleshoot.go:62
- [nitpick] The variable name
successfulis a bit ambiguous; consider renaming it to something likesuccessornoErrorsto make its intent clearer.
successful := true
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Changes the response of
[PUT] /system/connect/testto include the full test results