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.

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

fix: updated version of search endpoint /search/v2/jobs/export #125

Merged
merged 1 commit into from
Jun 24, 2024

Conversation

thilles
Copy link
Contributor

@thilles thilles commented Jun 7, 2024

The endpoint /search/jobs/export is depricated as of Splunk version 9.0.1. Updated to use v2 of endpoint.
Ref https://docs.splunk.com/Documentation/Splunk/9.2.1/RESTREF/RESTsearch#search.2Fjobs.2Fexport_.28deprecated.29

Copy link
Collaborator

@fantavlik fantavlik left a comment

Choose a reason for hiding this comment

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

Ah good call, thanks for the contribution. I wonder if it may be a bit early to force all users of the VSCode extension to be on Splunk 9.0.2 or later? Some options if we want to avoid that:

  1. Allow an extension setting to opt into v2 endpoints (on by default) that users on older versions of Splunk could opt out of
  2. Adopt the splunk-javascript-sdk for these calls, that SDK automatically checks which Splunk version is being used and uses v2 when available
  3. Hard cutover to v2 which would make the VSCode extension only usable for Splunk versions 9.0.2 and later (we would at least need to advertise this quite loudly if we go that route)

@JasonConger thoughts?

@JasonConger
Copy link
Collaborator

Thanks for the contribution @thilles. We always welcome contributions from the community!
@fantavlik adding an option in the extension to choose an endpoint would be okay in the short-term, but refactoring for the splunk-javascript-sdk would be the preferred long-term outcome.

@JasonConger JasonConger changed the base branch from master to v2-endpoint June 24, 2024 14:23
@JasonConger JasonConger merged commit 4bf382f into splunk:v2-endpoint Jun 24, 2024
@fantavlik
Copy link
Collaborator

fantavlik commented Jul 4, 2024

FYI I went for the long term option since it was easy enough - the SDK doesn't support the export endpoints but I used the SDK to determine which endpoints to use in this PR: #127

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants