[PR #48] [MERGED] 10 create rudimentary api interface #254

New issue

Closed

opened 2026-02-27 19:17:28 +03:00 by kerem · 0 comments

kerem commented

2026-02-27 19:17:28 +03:00

Owner

📋 Pull Request Information

Original PR: https://github.com/EddieTheCubeHead/Stagnum/pull/48
Author: @EddieTheCubeHead
Created: 1/29/2024
Status: ✅ Merged
Merged: 1/30/2024
Merged by: @EddieTheCubeHead

Base: master ← Head: 10-create-rudimentary-api-interface

📝 Commits (10+)

3e679d0 10 Restructure FastAPI files, add some basic models and routes
fe77cef More API routes and models
2550669 Revised database basics. Out of ticket scope but this should be done asap so others can fix the problem
59e0b12 10 update README with guide on viewing API docs
09216fc 10 add limit and offset for search routes
9c919e5 Merge branch '11-setup-alembic-migration-engine' into 10-create-rudimentary-api-interface
f18bd16 Merge branch 'master' into 10-create-rudimentary-api-interface
59b6572 Merge branch 'master' into 10-create-rudimentary-api-interface
a2090e5 10 add missing field to README table of contents
99a3a58 Remove extra line from pool/init

📊 Changes

18 files changed (+201 additions, -15 deletions)

View changed files

📝 server/README.md (+6 -0)
📝 server/src/alembic/versions/af9978211950_add_user_table.py (+8 -6)
📝 server/src/api/application.py (+10 -0)
➕ server/src/api/auth/__init__.py (+1 -0)
➕ server/src/api/auth/models.py (+9 -0)
➕ server/src/api/auth/routes.py (+18 -0)
➕ server/src/api/common/__init__.py (+0 -0)
➕ server/src/api/common/models.py (+6 -0)
➕ server/src/api/pool/__init__.py (+1 -0)
➕ server/src/api/pool/models.py (+26 -0)
➕ server/src/api/pool/routes.py (+28 -0)
➖ server/src/api/routes.py (+0 -6)
➕ server/src/api/search/__init__.py (+1 -0)
➕ server/src/api/search/models.py (+49 -0)
➕ server/src/api/search/routes.py (+33 -0)
📝 server/src/database/entities.py (+3 -1)
📝 server/src/main.py (+1 -1)
📝 server/test/conftest.py (+1 -1)

📄 Description

Better file structure with routers: no longer need to import application from routes (anti-pattern, bad coding by me)

Created a base for the known routes required for MVP release. This includes route skeleton and input + output data models.

Found out we need to store spotify data differently, modified original migration to accomodate that. This was not compatible with the first migration AND we are early in the project so it was done like this to reduce migration script amount. (Other option was to create a migration that drops the table and keep the first migration.)

In the future I will not modify existing migration, neither should anyone else.

_{🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.}

## 📋 Pull Request Information **Original PR:** https://github.com/EddieTheCubeHead/Stagnum/pull/48 **Author:** [@EddieTheCubeHead](https://github.com/EddieTheCubeHead) **Created:** 1/29/2024 **Status:** ✅ Merged **Merged:** 1/30/2024 **Merged by:** [@EddieTheCubeHead](https://github.com/EddieTheCubeHead) **Base:** `master` ← **Head:** `10-create-rudimentary-api-interface` --- ### 📝 Commits (10+) - [`3e679d0`](https://github.com/EddieTheCubeHead/Stagnum/commit/3e679d0e8321a7cb3125a159700e269d8f515156) 10 Restructure FastAPI files, add some basic models and routes - [`fe77cef`](https://github.com/EddieTheCubeHead/Stagnum/commit/fe77cefa2f623d85df7e02d0ad63a8c8ea0efd46) More API routes and models - [`2550669`](https://github.com/EddieTheCubeHead/Stagnum/commit/2550669b24845f599fad13dd8e8c825c08bfe0bd) Revised database basics. Out of ticket scope but this should be done asap so others can fix the problem - [`59e0b12`](https://github.com/EddieTheCubeHead/Stagnum/commit/59e0b12a4486160bac88b8c2a58ffb36b96c2d7a) 10 update README with guide on viewing API docs - [`09216fc`](https://github.com/EddieTheCubeHead/Stagnum/commit/09216fc088818a02309ba22b26a1302538b22588) 10 add limit and offset for search routes - [`9c919e5`](https://github.com/EddieTheCubeHead/Stagnum/commit/9c919e5941c6c61555db9e4eed205b38c84ccb01) Merge branch '11-setup-alembic-migration-engine' into 10-create-rudimentary-api-interface - [`f18bd16`](https://github.com/EddieTheCubeHead/Stagnum/commit/f18bd1639f34ae8341a8ba22c741438a91aff309) Merge branch 'master' into 10-create-rudimentary-api-interface - [`59b6572`](https://github.com/EddieTheCubeHead/Stagnum/commit/59b65724fdf187709bfe9bfd652bdbce09885ba1) Merge branch 'master' into 10-create-rudimentary-api-interface - [`a2090e5`](https://github.com/EddieTheCubeHead/Stagnum/commit/a2090e5ddaebba5f61bc2c3e868a3f3ac7abfd62) 10 add missing field to README table of contents - [`99a3a58`](https://github.com/EddieTheCubeHead/Stagnum/commit/99a3a58c88e21868eea4fce0f154f3b2576e9a93) Remove extra line from pool/init ### 📊 Changes **18 files changed** (+201 additions, -15 deletions) <details> <summary>View changed files</summary> 📝 `server/README.md` (+6 -0) 📝 `server/src/alembic/versions/af9978211950_add_user_table.py` (+8 -6) 📝 `server/src/api/application.py` (+10 -0) ➕ `server/src/api/auth/__init__.py` (+1 -0) ➕ `server/src/api/auth/models.py` (+9 -0) ➕ `server/src/api/auth/routes.py` (+18 -0) ➕ `server/src/api/common/__init__.py` (+0 -0) ➕ `server/src/api/common/models.py` (+6 -0) ➕ `server/src/api/pool/__init__.py` (+1 -0) ➕ `server/src/api/pool/models.py` (+26 -0) ➕ `server/src/api/pool/routes.py` (+28 -0) ➖ `server/src/api/routes.py` (+0 -6) ➕ `server/src/api/search/__init__.py` (+1 -0) ➕ `server/src/api/search/models.py` (+49 -0) ➕ `server/src/api/search/routes.py` (+33 -0) 📝 `server/src/database/entities.py` (+3 -1) 📝 `server/src/main.py` (+1 -1) 📝 `server/test/conftest.py` (+1 -1) </details> ### 📄 Description Better file structure with routers: no longer need to import application from routes (anti-pattern, bad coding by me) Created a base for the known routes required for MVP release. This includes route skeleton and input + output data models. Found out we need to store spotify data differently, modified original migration to accomodate that. This was not compatible with the first migration AND we are early in the project so it was done like this to reduce migration script amount. (Other option was to create a migration that drops the table and keep the first migration.) In the future I will not modify existing migration, neither should anyone else. --- <sub>🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.</sub>