Skip to content

External Tool API: Check if a File Meets the Requirements of a Given Tool #11938

@ChengShi-1

Description

@ChengShi-1

Overview of the Feature Request
Based on the discussion here IQSS/dataverse-frontend#815, certain external tools require auxiliary files before they can be used, we need an api for this condition. In the front end, currently we are filtering out external tools with requirements, which should be removed after this api.

To support this in the SPA and API workflows, a new endpoint is proposed to check whether a given file meets the requirements for a particular tool, like GET /api/files/{fileId}/meetsRequirements/{toolId}
This API could return a simple boolean result, indicating whether the file satisfies all the tool’s requirements.

What kind of user is the feature intended for?
(Example users roles: API User, Curator, Depositor, Guest, Superuser, Sysadmin)
API users

What inspired the request?

What existing behavior do you want changed?

Any brand new behavior do you want to add to Dataverse?

Any open or closed issues related to this feature request?
#11760

Are you thinking about creating a pull request for this feature?
Help is always welcome, is this feature something you or your organization plan to implement?

Metadata

Metadata

Assignees

No one assigned

    Labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions