Added litestar API endpoints - #36
Merged
kshitijrajsharma merged 7 commits intoMay 6, 2026
Merged
Conversation
kshitijrajsharma
requested changes
May 3, 2026
Collaborator
There was a problem hiding this comment.
Thanks for the slim PR , beautiful work !
few points ;
add .env example !
add instructions to quickly test the api and the readme , to insert the data and get the api up , usually should be two commands ! expand test cases for real test assertion
Contributor
Author
|
Updated. I added:
|
Contributor
Author
|
The API is now hosted on Render and connected to a Neon Postgres database. Health endpoint: User stats endpoint: The database was populated using: |
kshitijrajsharma
left a comment
Collaborator
There was a problem hiding this comment.
few minor changes !
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Adds an initial Litestar API inside the
osmsg/apipackage.This includes two active endpoints for now:
GET /healthGET /api/v1/usersThe API uses
asyncpgto query PostgreSQL and reads the database connection from theDATABASE_URLenvironment variable.Changes
osmsg/api/package with Litestar app, DB pool setup, and users query./healthendpoint for API health checks./api/v1/usersendpoint to return ranked user statistics from the current osmsg PostgreSQL tables.Procfilefor deployment.litestar[standard],asyncpg, anduv.Notes
The API currently expects osmsg data to already be exported into PostgreSQL using the current osmsg schema:
userschangesetschangeset_statsstateExample local run: