DRAFT: OpenAPI specification

.gitignore

@@ -136,3 +136,6 @@ dmypy.json
 
 # Cython debug symbols
 cython_debug/
+
+# VSCode/VSCodium
+.vscode/

.openapi-generator/FILES

@@ -1,6 +1,5 @@
 .flake8
 .gitignore
-.openapi-generator-ignore
 Dockerfile
 README.md
 docker-compose.yaml
@@ -9,14 +8,78 @@ pyproject.toml
 requirements.txt
 setup.cfg
 src/openapi_server/apis/__init__.py
+src/openapi_server/apis/account_registration_api.py
+src/openapi_server/apis/administration_api.py
+src/openapi_server/apis/api_token_validation_api.py
+src/openapi_server/apis/authentication_api.py
+src/openapi_server/apis/database_api.py
 src/openapi_server/apis/default_api.py
+src/openapi_server/apis/definition_api.py
+src/openapi_server/apis/information_api.py
+src/openapi_server/apis/internal_api.py
+src/openapi_server/apis/leaderboards_api.py
+src/openapi_server/apis/match_data_api.py
+src/openapi_server/apis/profile_administration_api.py
+src/openapi_server/apis/ratings_api.py
+src/openapi_server/apis/search_api.py
+src/openapi_server/apis/statistics_api.py
+src/openapi_server/apis/status_check_api.py
+src/openapi_server/apis/team_administration_api.py
+src/openapi_server/apis/teams_api.py
+src/openapi_server/apis/tournament_administration_api.py
+src/openapi_server/apis/tournaments_api.py
+src/openapi_server/apis/user_administration_api.py
 src/openapi_server/main.py
 src/openapi_server/models/__init__.py
-src/openapi_server/models/error.py
+src/openapi_server/models/accepted.py
+src/openapi_server/models/authorization_header.py
+src/openapi_server/models/count_param.py
 src/openapi_server/models/extra_models.py
+src/openapi_server/models/forbidden_error.py
+src/openapi_server/models/game_id.py
 src/openapi_server/models/illegal_input_error.py
+src/openapi_server/models/language_string.py
+src/openapi_server/models/match_id.py
+src/openapi_server/models/match_status.py
+src/openapi_server/models/md5.py
+src/openapi_server/models/no_content.py
+src/openapi_server/models/not_acceptable_error.py
+src/openapi_server/models/not_found_error.py
+src/openapi_server/models/not_implemented_error.py
+src/openapi_server/models/relic_link_id.py
+src/openapi_server/models/request_timeout_error.py
+src/openapi_server/models/search_param.py
 src/openapi_server/models/server_error.py
+src/openapi_server/models/service_unavailable_error.py
+src/openapi_server/models/since_param.py
+src/openapi_server/models/start_param.py
+src/openapi_server/models/steam_id.py
+src/openapi_server/models/timeframe.py
+src/openapi_server/models/too_many_requests_error.py
+src/openapi_server/models/ulid.py
 src/openapi_server/models/unauthorized_error.py
+src/openapi_server/models/unsupported_media_type_error.py
+src/openapi_server/models/www_authenticate.py
 src/openapi_server/security_api.py
 tests/conftest.py
+tests/test_account_registration_api.py
+tests/test_administration_api.py
+tests/test_api_token_validation_api.py
+tests/test_authentication_api.py
+tests/test_database_api.py
 tests/test_default_api.py
+tests/test_definition_api.py
+tests/test_information_api.py
+tests/test_internal_api.py
+tests/test_leaderboards_api.py
+tests/test_match_data_api.py
+tests/test_profile_administration_api.py
+tests/test_ratings_api.py
+tests/test_search_api.py
+tests/test_statistics_api.py
+tests/test_status_check_api.py
+tests/test_team_administration_api.py
+tests/test_teams_api.py
+tests/test_tournament_administration_api.py
+tests/test_tournaments_api.py
+tests/test_user_administration_api.py

.vscode/settings.json

@@ -0,0 +1,5 @@
+{
+    "yaml.schemas": {
+        "openapi:v3": "file:///c%3A/Users/dailyuse/dev-src/librematch-backend/openapi.yaml"
+    }
+}

README.md

@@ -2,7 +2,7 @@
 
 This Python package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
 
-- API version: 1.0.0
+- API version: 1.0.0-DRAFT
 - Build package: org.openapitools.codegen.languages.PythonFastAPIServerCodegen
 
 ## Requirements.

docs/design/responses/TODO_RESPONSES.md

@@ -0,0 +1,34 @@
+# Responses that need to be designed
+
+## TODO
+
+- GET /application/status
+- GET /dumps/{timeframe}
+- GET /users/validate
+- GET /games/{game_id}/definitions
+- GET /games/{game_id}/info
+
+### Blocking
+
+- GET /games
+- GET /games/{game_id}
+- GET /games/{game_id}/matches
+- GET /games/{game_id}/leaderboards
+- GET /games/matches/{match_uuid}
+- GET /profiles
+- GET /profiles/{relic_link_id}
+- GET /profiles/{relic_link_id}/matches
+- GET /profiles/{relic_link_id}/ledger
+- GET /leaderboards
+- GET /leaderboards/{leaderboard_id}
+- GET /leaderboards/{leaderboard_id}/matches
+
+## Done
+
+- GET /games/matches/{match_uuid}
+- GET /profiles/search?steam_id
+- GET /profiles/search?alias
+
+## Notes
+
+- do we need ranks/percentiles in ratinghistory, so people can use that to create a graph of profiles also for their ranking at a certain moment in time? (-> Coolio)