henry
/
AccessQueueService
1
0
Fork 0
Code Issues 4 Pull Requests Packages Projects Releases Wiki Activity

Added new routes to readme - closes #21

This commit is contained in:
henry 2025-06-17 19:34:26 -04:00
parent 76009824a6
commit 0881743fcc
1 changed files with 15 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
README.md
View File

@ -59,6 +59,21 @@ It is possible for the number of users with access to temporarily exceed the `Ca
- **Description:** Revoke access for a user with the specified `id`. This will remove the user from the active list or queue and may allow the next user in the queue to gain access. - **Description:** Revoke access for a user with the specified `id`. This will remove the user from the active list or queue and may allow the next user in the queue to gain access.
- **Response:** Returns a boolean indicating success. - **Response:** Returns a boolean indicating success.
### Get Service Status
- **GET /status**
- **Description:** Returns the current status of the access queue, including active users, queue length, and other statistics.
- **Response:** Returns an `AccessQueueStatus` object.
### Get Configuration
- **GET /config**
- **Description:** Returns the current configuration of the access queue service.
- **Response:** Returns an `AccessQueueConfig` object.
### Update Configuration
- **POST /config**
- **Description:** Updates the configuration of the access queue service. Accepts a partial or full `AccessQueueConfig` object in the request body.
- **Response:** Returns no content on success (HTTP 204).
## Configuration Variables ## Configuration Variables
Configuration is set in `appsettings.json` or via environment variables. The main configuration section is `AccessQueue`: Configuration is set in `appsettings.json` or via environment variables. The main configuration section is `AccessQueue`: