SYN-6862: remove decommissioned v1 (Rigor) client and update README - #57
Merged
Conversation
The v1 syntheticsclient package targeted the retired monitoring-api.rigor.com endpoint and has been deprecated since the v2 client shipped. Delete the package, its models, and its tests, and drop the Makefile/coverage config that special-cased it. Rewrite the README to document only the supported v2 client: correct `go get` install command for the /v2 module path, token/ realm configuration, and a current example. Co-Authored-By: Claude <noreply@anthropic.com>
jcsco
requested review from
etipton-splunk and
jinja2
and removed request for
a team
August 21, 2026 21:48
|
CLA Assistant Lite bot CLA Assistant Lite bot All contributors have signed the COC ✍️ ✅ |
|
Code Coverage Report: |
There was a problem hiding this comment.
💡 Codex Review
Here are some automated review suggestions for this pull request.
Reviewed commit: b653f8bd3c
ℹ️ About Codex in GitHub
Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you
- Open a pull request for review
- Mark a draft as ready
- Comment "@codex review".
If Codex has suggestions, it will comment; otherwise it will react with 👍.
Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".
Collaborator
Author
|
recheck |
Integration Test: ✅ PassedLive integration tests — Total: 60 | Passed: 60 | Failed: 0 | Skipped: 0
|
bchhay-splunk
approved these changes
Aug 24, 2026
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
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
Summary
syntheticsclient/package (19 files, ~1,970 lines): the deprecated v1 client for the retiredmonitoring-api.rigor.compublic API, its models, and its unit tests.COVERPKGcarve-out from theMakefileand the corresponding comment from.testcoverage.yml; the whole module (now justsyntheticsclientv2) is measured for coverage.syntheticsclientv2client: corrects thego getinstall command to the actual/v2module path (go get github.com/splunk/syntheticsclient/v2), adds an explicit token/realm configuration section, and drops the Rigor branding/links.syntheticsclientv2behavior is unchanged — no production code in that package was touched.Compatibility / release impact
github.com/splunk/syntheticsclient/v2/syntheticsclient) from the module. Any consumer still importing that subpackage directly (rather thansyntheticsclientv2) will fail to build after upgrading past this change.v3convergence merge, commit6fc7a64), so this completes that planned removal rather than introducing a new one./v2module path. Per Go's module major-version rules, removing a public package breaks the compatibility promise of the existingv2.xline, and tagging itv3.0.0would also be invalid as-is, since a v3 release requires the module path itself to read.../v3(go.mod still says/v2). This PR does not perform that module-path bump — it's tracked as a follow-up before any tag is cut from this branch. Until that lands,mainshould not be released.v2.xconsumers (e.g.terraform-provider-synthetics, pinned tov2.x) are unaffected: the frozenv2branch/tags are untouched by this change.syntheticsclientv2's public API is unchanged, so no consumer of the supported client needs to change their code once the eventual v3 release ships.Test plan
Rigor,monitoring-api.rigor.com, ormonitoring.rigor.comin the repo.make fmtcheck,make vet,make buildpass.make test-coverpasses;syntheticsclientv2coverage is 94.5% (floor is 90%).make test-racepasses.make lint(golangci-lint v2.12.2) reports 0 issues.make govulncheckreports no vulnerabilities.make actionlintpasses.Refs: https://splunk.atlassian.net/browse/SYN-6862
🤖 Generated with Claude Code