On flow names, external versions and URI-safe characters
Nobody has claimed this yet.
Assessment
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Newbie friendliness
- 45/100
Research direction
Start by locating the flow/exists GET and POST handlers and reviewing issue #31, then trace how published flows and the openml-python API call them. Done means one supported POST endpoint can retrieve all required flows without breaking compatibility for existing names and external versions.
Written by the indexing model from the issue text.
Description
The flow/exists endpoint (#31) currently supports both GET and POST requests because there are names and/or external versions which contain characters which would make it an invalid path if added to the URI. I think we should make a decision to either always require a POST request, or to reconsidered the allowed values for flow names and external versions. I think it's confusing that now there are two endpoints with the same purpose, especially since the hidden POST endpoint is the one actually able to retrieve all the flows. The problem with the approach that restricts names/version characters is that changing keeps the problem with currently published flows. These cannot easily be updated, as it also requires changes to the openml-python API if it needs to support the migrated scheme.
Proposal: Remove the GET endpoint, and only support POST.
- Dominant language
- Python
- Stars
- 16
- Forks
- 50
- PR merge metrics
- No merged PRs in 30d
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from openml/server-api
-
behavior
Difficulty 2/5 1-3 hours Newbie friendliness 62/100
openml/server-api#337 · 1 comment ·
-
proposal
openml/server-api#375 · 2 comments · 1 assignee ·
-
openml/server-api#374 · 2 comments · 1 assignee ·
-
openml/server-api#373 · 1 assignee ·
-
openml/server-api#372 · 1 assignee ·
All issues in openml/server-api
Similar issues
-
bug confirmed issue
Difficulty 2/5 1-3 hours Newbie friendliness 75/100
open-webui/open-webui#30750 · 1 comment ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 75/100
-
enhancement
Difficulty 2/5 1-3 hours Newbie friendliness 75/100
OpenwaterHealth/openmotion-bloodflow-app#604 · 1 comment ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 70/100
-
good first issue
Difficulty 1/5 Under an hour Newbie friendliness 90/100