You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
title: "Join the GameVault Early-Access Program Now!"
3
+
authors: [alfagun74]
4
+
tags:
5
+
[
6
+
Gaming,
7
+
GameVault,
8
+
Early Access,
9
+
UI Update,
10
+
Beta Testing,
11
+
Community Feedback,
12
+
Exclusive Preview,
13
+
Microsoft Store,
14
+
Discord,
15
+
Gaming Servers,
16
+
]
17
+
---
18
+
19
+
Hey, Guys!
20
+
21
+
For the upcoming large UI update of GameVault, we're launching a brand new GameVault Early-Access Program, and we want **YOU** to be a part of it!
22
+
23
+
**What's the Early-Access Program?**
24
+
Early-Access is your golden ticket to test-drive upcoming GameVault updates before anyone else. You'll be part of an exclusive group and get a sneak peek into the latest features, but here's the deal – it might not be as stable as our regular releases and you need to interact with us. Your feedback will help us fine-tune everything before the big release for everyone else.
25
+
26
+
**How to Join:**
27
+
:clipboard: Complete the [Application Form](https://forms.gle/RQvEGfWeUFPBCUaG6)
28
+
:date: The first early-access phase kicks off on December 17 and lasts for one week.
29
+
30
+
**Prerequisites:**
31
+
:speech_balloon: Active participation in the designated Discord channel.
32
+
:video_game: GameVault installed from the Microsoft Store with a Microsoft Account logged in. If not, grab it [here](https://www.microsoft.com/store/apps/9PCKDV76GL75).
33
+
:rocket: A GameVault Server running the **phalcode/gamevault-backend:early-access** image. (Only run this if you are accepted as a Tester as it could break things!)
34
+
35
+
Important Note:
36
+
37
+
- There are only a limited number of slots in the Early-Access Program. Supporters and Trusted Members are prioritized.
38
+
- If you're accepted and later found not meeting the requirements, you might be removed from future testing and the next applicant on our list gets the opportunity.
Copy file name to clipboardExpand all lines: docs/advanced-usage/api-usage.md
+14-10Lines changed: 14 additions & 10 deletions
Original file line number
Diff line number
Diff line change
@@ -12,22 +12,26 @@ To use the GameVault API, it is recommended to register a separate user. This us
12
12
13
13
## API Documentation
14
14
15
-
Once you have registered your account, you can check out the API documentation at `example.com/api/docs`. The API documentation provides a complete guide on how to use the API, including authentication, endpoints, and parameters.
15
+
You can check out the API documentation at `example.com/api/docs` after making sure the server environment variable `SERVER_API_DOCS_ENABLED` is set to `true`.
16
16
17
-
You can also download the OpenAPI Specification using `example.com/api/docs-json` or `example.com/api/docs-yaml`. This is useful for importing the Calls into a tool like Postman or generate the client code using the openapi-generator.
17
+
The API documentation provides a complete guide on how to use the API, including authentication, endpoints, and parameters.
18
+
19
+
You can also download the OpenAPI Specification in different formats using `example.com/api/docs-json` or `example.com/api/docs-yaml`. This is useful for importing the Calls into a tool like Postman or generate the client code using the openapi-generator.
18
20
19
21
## API Endpoints
20
22
21
23
Some of the available API endpoints include:
22
24
23
-
-**Games API**: APIs for searching and downloading games
24
-
-**Progress API**: APIs for tracking and managing user progress for games
25
-
-**Tags API**: API for retrieving a list of tags
26
-
-**Genres API**: API for retrieving a list of genres
27
-
-**User API**: APIs for managing user profiles and authentication
28
-
-**Utility API**: Miscellaneous APIs for manual indexing, caching, and updating
29
-
-**Rawg API**: APIs for interacting with the Rawg game database
30
-
-**Images API**: API for retrieving images by UUID.
25
+
-**/admin API**: APIs for administration of your gamevault server
26
+
-**/health API**: APIs for health monitoring
27
+
-**/games API**: APIs for searching and downloading games
28
+
-**/progresses API**: APIs for tracking and managing user progress for games
29
+
-**/files API**: API for reindexing the game files
30
+
-**/tags API**: API for retrieving a list of tags
31
+
-**/genres API**: API for retrieving a list of genres
32
+
-**/users API**: APIs for managing user profiles and authentication
33
+
-**/rawg API**: APIs for interacting with the Rawg game database
34
+
-**/images API**: API for retrieving images by UUID.
0 commit comments