opensafely-core / opensafely-core/opencodelists
Decide if the API is public-facing
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 60
- Forks
- 16
- Avg merge
- 4d 12h
- Merged PRs (30d)
- 17
Description
Why are we doing this?
Without deciding whether the API is public facing it's harder to decide whether to do some tasks, or how to implement them. For example, deciding CORS policy for the site, and whether to do issues #2190 #2191.
The OpenCodelists API is needed for other OpenSafely components such as the CLI and cohort-extractor. Nothing stops others from accessing the API on the web. We're aware of at least one researcher-created tool that uses the API.
#2132 would help with identifying non-Bennett-tech clients of the API.
How will we know when it's done?
We have reached a decision documented in an ADR. Related tickets are updated or created.
What are we doing?
Discussion in the team and with stakeholders.
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 reading codelists/api.py and the context in issues #2190, #2191, and #2132. Discuss the API's public-facing status with the team and stakeholders, then document the decision in an ADR and update or create related tickets.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- api
- Issue type
- Documentation
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Clearly specified
- Newbie friendliness
- 25/100