Have the flow/exists endpoint return the flow on success
Nobody has claimed this yet.
Assessment
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Newbie friendliness
- 35/100
Research direction
Start by locating the flow/exists endpoint and the existing flow lookup and response behavior in the Python-based server API. Compare its not-found and success responses with the flow retrieval endpoint; done means the API behavior and response shape are agreed and implemented, including whether subflows or an optional parameter are included.
Written by the indexing model from the issue text.
Description
The PHP API returns a standard response:{"flow_exists": {"exists": true or false, "flow_id": id or -1}}. However, to retrieve the information whether or not a flow exists, we need to query the database and get just as much information as when actually returning the flow (ignoring any subflows). So returning the flow information does not generally occur much additional overhead.
It also feels like it is just another side of the same coin: you get the flow by its unique id, or by its unique combination of (name, external_version). It would make sense for me to make those endpoints behavior the same w.r.t. finding and not finding a flow.
Because of the extra network traffic (a little bit of json) and db load (in case of resolving subflows), we could also consider returning the whole flow based on a parameter, or simply have an extra endpoint that has this behavior.
- 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
-
Difficulty 1/5 Under an hour Newbie friendliness 75/100
-
hcocena Openpolicies-accepted pre-review precheck-passed
Difficulty 1/5 Under an hour Newbie friendliness 88/100
Bioconductor/BiocContributions#214 · 5 comments ·
-
Difficulty 1/5 Under an hour Newbie friendliness 92/100
TencentCloud/Octop#1169 · 1 comment ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 70/100
521xueweihan/HelloGitHub#3778 ·
-
The version checker's trailing attribute region has no control for a less-than inside a quoted value Openarea: dashboard area: tests bug perceived difficulty: 2 python
Difficulty 2/5 1-3 hours Newbie friendliness 84/100
Nitjsefnie-Harness-Commons/daedalus#1105 · 1 comment ·