openlibhums / openlibhums/janeway
Preprints: API feed should display custom fields
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 238
- Forks
- 97
- Avg merge
- 9d 1h
- Merged PRs (30d)
- 8
Description
Is your feature request related to a problem? Please describe.
As a Janeway preprints administrator, I want to ensure that systems reading preprints metadata are able to obtain all information that they see on the public item page, including custom fields.
Describe the solution you'd like
Add to the Preprints API custom fields provided in Janeway for the repository:
- repository_repositoryfield
Additional context
We don't think that this is necessary to include in the initial release of the preprints API (https://github.com/BirkbeckCTP/janeway/issues/3010 / https://github.com/BirkbeckCTP/janeway/pull/3166 )
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.
Research direction
Locate the Preprints API endpoint and its response-building code, then trace how repository custom fields are represented. Verify the API output for a preprint includes repository_repositoryfield and add or update coverage for that response; done means API consumers can obtain the field shown on the public item page.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- api
- Issue type
- Feature
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100