Review outstanding TODOs
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 0
- Forks
- 13
- Avg merge
- 1h 17m
- Merged PRs (30d)
- 1
Description
This issue collects the TODO/FIXME comments in the nsls2api application. Review each item and decide whether to complete it, revise it, or remove it.
Partially Done
-
Sort facility operating cycles
Existing sort logic needs verification and a multi-cycle test. -
Validate beamline names
Names are uppercased, but invalid input is not rejected. -
Use facility health checks in the current-cycle endpoint
facility_service.is_healthy()exists but is not used by this endpoint. -
Finalize beamline account endpoint design
An aggregate endpoint exists; individual account routes are hidden.
Open
Completed
- Publish
/person/mein OpenAPI
The endpoint already hasinclude_in_schema=True; remove or update the outdated TODO.
Vendored HTMX, Not Local Application Work
The application loads htmx.min.js; htmx.js is the readable vendored source. These TODOs belong upstream and should only be addressed through an HTMX upgrade.
- Document HTMX public API methods
- Rework HTMX document-fragment handling
- Remove legacy Internet Explorer code
- Rework HTMX SSE/AJAX/WebSocket behavior
- Define HTMX response-header typing
Vendored Font Awesome, Not Local Application Work
Do not modify vendored HTMX or Font Awesome files directly; handle them through upstream dependency upgrades.
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 by reviewing the linked TODO locations in the facility, beamline, proposal, user, and jobs service/API files, separating the local application items from the vendored HTMX and Font Awesome items. Check existing tests and endpoint behavior for each local TODO, then define a focused scope and acceptance criteria; done means each retained TODO has a resolution and outdated or upstream-only items are removed or documented.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- fastapi, python
- Domain
- api, backend
- Issue type
- Refactor
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Active
- Clarity
- Needs clarification
- Newbie friendliness
- 30/100