Minz/toho-jose
1
0
Fork 0
Code Issues 4 Pull Requests Actions Packages Projects Releases Wiki Activity

Added endpoint docs to readme

Browse Source
This commit is contained in:
Minzkraut
2023-01-11 13:16:23 +01:00
committed by GitHub
parent f2e1ac2711
commit 1786bc39d2
1 changed files with 14 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

15
README.md
View File

@@ -1 +1,14 @@
# Render Server
# Render Job Server
## Endpoints:
- [GET] /
- Returns a string "Job handling server"
- [GET] /jobs
- Returns a JSON object containing a count and items for the `queued`, `waiting`, and `finished` jobs.
- [POST] /jobs
- Accepts a JSON object in the request body, generates a unique job ID using an MD5 hash, and adds the job to the `queued` jobs object. The generated job ID and a status code of `200` are returned in the response.
- [GET] /batch
- Returns a JSON object containing a count and items for jobs from the `queued` object in the amount specified in the `size` query parameter, or the amount of items in the `queued` object, whichever is smaller.
The returned jobs are added to the `waiting` jobs object and removed from the `queued` jobs object.
- [POST] /jobs/:jobId/completed
- Accepts a jobId in the path parameter, marks it as completed and moves it from waiting to finished.