HumanBrainProject / HumanBrainProject/hbp-validation-framework

Retrieving models/tests by alias doesn't work for all users

Open
#340 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

REST API v2
Dominant language
Python
Stars
5
Forks
12
PR merge metrics
No merged PRs in 30d

Description

This is because retrieving by alias uses queries that are stored in the "model" space, and so only accessible to model curators.

This may be fixed in future, i.e. released queries will be executable by anyone (Oli said: "technically speaking, queries are indeed normal resources and therefore can be released and are readable for the end user e.g. through the instances api - but we need to review the queries endpoint to make the query execution happening (so far we've always assumed queries to be read from "in progress" in a Slack conversation, early March 2023).

For now, the best solution would probably be to generate the queries (or read from file) within the VF API.

Contributor guide

No contributing guide indexed for this repository

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 tracing alias-based model and test retrieval through the VF API, including how queries are read from the "model" space and how the instances API exposes released queries. Review the queries endpoint assumptions described in the issue. Done means non-curator users can retrieve models and tests by alias without relying on curator-only query access.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
api, backend
Issue type
Bug
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
30/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.