From 1e965d1b8fa9dda9d5d77ddb88ae2f16be0195b7 Mon Sep 17 00:00:00 2001 From: Fleeym <61891787+Fleeym@users.noreply.github.com> Date: Fri, 23 Feb 2024 00:01:01 +0200 Subject: [PATCH] update README and spec --- README.md | 16 ++++++++-------- openapi.yml | 2 +- 2 files changed, 9 insertions(+), 9 deletions(-) diff --git a/README.md b/README.md index a1f7ae1..82ab451 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,8 @@ # Geode Server -WIP version of the new Geode Index, hosted on its own server rather than a Github repository. Uses Actix, PostgreSQL and SQLX in Rust. +The new home of the Geode Index, hosted on its own server rather than a Github repository. Uses Actix, PostgreSQL and SQLX in Rust. + +The API documentation can be found [here](https://geode-sdk.github.io/server/) ## Checklist @@ -9,14 +11,12 @@ WIP version of the new Geode Index, hosted on its own server rather than a Githu - [x] Support for multiple developers per mod - [x] Github OAuth - [x] A token system for authenticating the CLI -- [ ] logo.png management -- [ ] Download counts -- [ ] External dependencies - -If you want to contribute to this project, please do so! I have no bloody clue how to write a web server. +- [x] logo.png management +- [x] Download counts +- [x] External dependencies ## Required tools for development -- sqlx-cli -- PostgreSQL +- sqlx-cli (for handling migrations) +- PostgreSQL (best way to do this is just to get a docker container set up) diff --git a/openapi.yml b/openapi.yml index ee8c9c6..090033d 100644 --- a/openapi.yml +++ b/openapi.yml @@ -36,7 +36,7 @@ paths: properties: error: type: "null" - token: + payload: type: object properties: uuid: