Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

API endpoint for fetching a single codelist #2191

Open
mikerkelly opened this issue Dec 2, 2024 · 1 comment
Open

API endpoint for fetching a single codelist #2191

mikerkelly opened this issue Dec 2, 2024 · 1 comment
Labels
deck-scrubbing Tech debt or other between-initiative tidy-up work

Comments

@mikerkelly
Copy link
Contributor

Add an API endpoint to fetch a single codelist directly by slug.

There is no current client for this in the OpenSAFELY systems, but it seems plausibly useful to those interested in using the OpenSAFELY API in scripting and tooling. Part of the "Open" ethos is that the resources that are publicly human-accessible on the site should be conveniently accessible in machine-readable form via an API.

It would be useful in https://github.com/ebmdatalab/codeusage/, allowing it to avoid needing to decode the organization from the slug and fetch all codelists in the organization then find the specific codelist within the response. This is slowing down this tooling and slightly inefficient for our resource consumption.

@iaindillingham iaindillingham added the deck-scrubbing Tech debt or other between-initiative tidy-up work label Dec 3, 2024
@iaindillingham
Copy link
Member

Thanks for this, @mikerkelly. From today's planning meeting, I believe you created it in response to speaking with Milan at the OpenSAFELY Symposium. It's not quite urgent or important enough to be addressed during the OpenCodelists initiative, but we can return to it during deck-scrubbing.

Before we do, we should consider whether the OpenCodelists API is public in the sense of "we expect it to be used by clients that weren't created by the tech team".

See also #2190

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
deck-scrubbing Tech debt or other between-initiative tidy-up work
Projects
None yet
Development

No branches or pull requests

2 participants