IQSS / IQSS/dataverse

Feature Request: Improve CVOC Retrieval filtering mechanism for Local Contexts

Open
#11,924 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

GREI 5 Type: Feature
Dominant language
Java
Stars
1.1k
Forks
564
Avg merge
2d 2h
Merged PRs (30d)
29

Description

Overview of the Feature Request
Local Contexts Integration leverages the external vocabulary mechanism. The relevant JavaScript leverages Dataverse as an authenticating proxy to access the Local Contexts v2 api. (see #11294).

One limitation of this related to retrieval-filtering. The proxy API added requires knowing both the Dataverse dataset id and the Local Contexts project id (a security measure to avoid Dataverse being usable as a way to get information about arbitrary Local Contexts projects - the api will only return useful content for projects associated with the specified dataset). Unfortunately, the current retrieval filtering mechanism, while allowing some parameterization of the retrieval-url, does not allow inserting the id of the dataset when trying to retrieve content.

For retrieval filtering to work with Local Contexts v2 api, we either need a way to specify adding a dataset id in the grammar for the retrieval-url field of the external vocabulary configuration, or a new API call in Dataverse, possibly restricted to localhost-only, allowing lookup of a project without knowing the dataset id, or some other relevant change.

For now, the Local Context configuration examples still use the v1 API (which is limited in terms of which fields are returned and presumably will go away at some point), so moving to support the v2 API is more of a feature-request/next-step than an immediate issue/bug in using the Local Contexts Integration.

Are you thinking about creating a pull request for this feature?
TBD - depending on the scope of the ongoing Local Contexts projects

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reading the Local Contexts integration guide, issue #11294, and the external-vocabulary retrieval-url configuration grammar. Compare the current v1 examples with the v2 proxy requirements, especially dataset and project IDs. Done means the configuration or API path can retrieve Local Contexts v2 content without weakening the dataset-association restriction.

Written by the indexing model from the issue text.

Assessment

Tech stack
java, javascript
Domain
api, backend
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
28/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.