Add parent "program" + "facility" to beamline?
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 0
- Forks
- 13
- Avg merge
- 1h 17m
- Merged PRs (30d)
- 1
Description
@nmaytan recently suggested that it would be useful to include the beamline's home program (e.g. "IOS" is in the "Spectroscopy" program at NSLS-II) in the payload returned by e.g. the /v1/beamlines endpoint.
@HarikaBishai suggested that perhaps the beamline's facility should be included too. At the moment there seems to be the tacit understanding that all beamlines are "NSLS-II" beamlines (as opposed to CFN, LBMS, CryoEM, etc.). That might be ok, given the name of this repo is "nsls2api" -- but we should probably codify this one way or the other.
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.
Research direction
Start with the /v1/beamlines endpoint; the issue names no file or test, so trace where its beamline payload is assembled. First resolve whether program and facility should be represented, then align the endpoint with that decision; done means the API contract consistently exposes the agreed metadata.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- fastapi, python
- Domain
- api, backend
- Issue type
- Feature
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 35/100