Add return type for directory skeletons
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 0
- Forks
- 13
- Avg merge
- 1h 17m
- Merged PRs (30d)
- 1
Description
Use a model for the various directory return types, e.g. in the beamline_service.directory_skeleton() function (https://github.com/NSLS2/nsls2api/blob/main/src/nsls2api/services/beamline_service.py#L322)
This can then be return also by the API route(s).
We can then include in the testing.
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 src/nsls2api/services/beamline_service.py at beamline_service.directory_skeleton(), then inspect the API routes that expose directory skeletons and the existing tests. Define models for the various directory return types, use them in the service and routes, and add test coverage for the typed responses.
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
- Mostly clear
- Newbie friendliness
- 42/100