Hierarchial Patch URLs
Nobody has claimed this yet.
Assessment
- Difficulty
- 5/5
- Estimated time
- Over a week
- Newbie friendliness
- 25/100
Research direction
Start with the Patch model's id field and the existing patch URL handling described in the issue. Define how a project-scoped identifier should coexist with legacy URLs, then verify that project-specific URLs resolve correctly while the old references remain supported.
Written by the indexing model from the issue text.
Description
From @stephenfin on June 29, 2015 21:24
Overview
At the moment, patchwork uses the Patch model id field for referencing patches via URL. This means if multiple projects exist then patch IDs won't be sequential (some IDs will be allocated to patches of one project, others to another). This works, but it doesn't allow for easy programmatic scanning of projects and doesn't translate well to REST APIs. Instead, IDs should be unique to the project. We can do this by adding a second ID field and allowing users to reference this. This will lead to a transformation like so:
/10234 --> /project_a/1000
/10245 --> /project_b/567
/10246 --> /project_c/8236
/10247 --> /project_a/1001
We should also keep the old way of referencing such resources but with an eye on deprecating these in the future.
Dependencies
N/A
Additional Work Items
N/A
Alternatives
We continue to use the patch URLs we use currently.
Useful resources
N/A
Copied from original issue: stephenfin/patchwork#21
- Dominant language
- Python
- Stars
- 317
- Forks
- 91
- PR merge metrics
- No merged PRs in 30d
Contributor guide
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 getpatchwork/patchwork
-
Difficulty 2/5 1-3 hours Newbie friendliness 68/100
getpatchwork/patchwork#668 ·
-
bug web-ui
Difficulty 2/5 1-3 hours Newbie friendliness 74/100
getpatchwork/patchwork#546 · 2 comments ·
-
Difficulty 3/5 1-2 days Newbie friendliness 52/100
getpatchwork/patchwork#664 ·
-
Difficulty 4/5 3-5 days Newbie friendliness 48/100
getpatchwork/patchwork#663 ·
-
Difficulty 3/5 1-2 days Newbie friendliness 45/100
getpatchwork/patchwork#645 ·
All issues in getpatchwork/patchwork
Similar issues
-
Add: hunch Open
Difficulty 2/5 1-3 hours Newbie friendliness 74/100
AbdelStark/awesome-typesafe#104 ·
-
enhancement
Difficulty 2/5 1-3 hours Newbie friendliness 72/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 68/100
DiamondLightSource/dodal#2211 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 88/100
openml/openml-python#1749 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 88/100
sipyourdrink-ltd/bernstein#6191 ·