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

Support putting variables in the path of a URL for external tools #9345

Open
craig-willis opened this issue Jan 30, 2023 · 1 comment · May be fixed by #10473
Open

Support putting variables in the path of a URL for external tools #9345

craig-willis opened this issue Jan 30, 2023 · 1 comment · May be fixed by #10473
Labels
Feature: External Tool hacktoberfest It's Hacktoberfest! https://groups.google.com/g/dataverse-community/c/n_Nn_T2yA-w/m/BcoXO4tEAQAJ Help Wanted: Code Mentor: pdurbin Size: 30 A percentage of a sprint. 21 hours. (formerly size:33) Type: Feature a feature request User Role: Guest Anyone using the system, even without an account

Comments

@craig-willis
Copy link
Contributor

craig-willis commented Jan 30, 2023

Overview of the Feature Request

Adding Binder support has highlighted a limitation in the external tools implementation. As discussed in #4714 (comment), #6807 (comment), and most recently in #6807 (comment), Binder has a specific URL format requires path-based variable replacement on the toolUrl field.

The feature request is to update the external tools integration to allow path-based variable replacement in the toolUrl field to enable creation of a Binder-complatible URL:

https://mybinder.org/v2/dataverse/{datasetPid}

Something like:

{
  "displayName": "Binder",
  "description": "Run on Binder",
  "scope": "dataset",
  "type": "explore",
  "toolUrl": "https://mybinder.org/v2/dataverse/{datasetPid}",
  "toolParameters": {
    "pathParameters": [
      {   
        "datasetPid": "{datasetPid}"
      }
    ]   
  }
}

Current integration depends on an external service that does translation and will be a potential point of failure for anyone that uses. it.

What inspired the request?
#6807 (comment)

What existing behavior do you want changed?

External tools to support Binder URLs without relying on an external service.

Any related open or closed issues to this feature request?

@pdurbin pdurbin added Type: Feature a feature request Help Wanted: Code Mentor: pdurbin User Role: Guest Anyone using the system, even without an account Feature: External Tool hacktoberfest It's Hacktoberfest! https://groups.google.com/g/dataverse-community/c/n_Nn_T2yA-w/m/BcoXO4tEAQAJ Size: 30 A percentage of a sprint. 21 hours. (formerly size:33) labels Oct 7, 2023
@pdurbin
Copy link
Member

pdurbin commented Mar 12, 2024

Thanks, @craig-willis for opening this issue.

We absolutely still want this feature, the ability to put variables in the path of a URL for an external tool.

Meanwhile, for Binder, yesterday we set up a static page with some Javascript that inserts the DOI in the path:

@pdurbin pdurbin changed the title Allow path replacement for external tools Allow URL path replacement for external tools Mar 29, 2024
@pdurbin pdurbin changed the title Allow URL path replacement for external tools Support putting variables in the path of a URL for external tools Mar 29, 2024
@zearaujo25 zearaujo25 linked a pull request Apr 9, 2024 that will close this issue
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Feature: External Tool hacktoberfest It's Hacktoberfest! https://groups.google.com/g/dataverse-community/c/n_Nn_T2yA-w/m/BcoXO4tEAQAJ Help Wanted: Code Mentor: pdurbin Size: 30 A percentage of a sprint. 21 hours. (formerly size:33) Type: Feature a feature request User Role: Guest Anyone using the system, even without an account
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants