API Definition (WIP)

Tools

GET /api/tools/

Returns a list of the available backend tools with the necessary fields to render the navbar etc. Does NOT include tool parameters.

[]

---

GET /api/tools/version/

Returns the version of the tools.conf to allow for caching them.

---

GET /api/tools/:id/

Returns the tool with every necessary information to render its tool view.

{
  "name": "hhblits",
}

Jobs

POST /api/jobs/

Submits a job.

---

GET /api/jobs/

Returns a list of jobs with just the most basic information for the job list etc.

[]

---

GET /api/jobs/:id/

Returns all the information of a job. The frontend will get this information from the WebSocket aswell. Includes only the first hundred hits if the tool is a search tool.

{}

---

GET /api/jobs/:id/hits/?start=&end=&color=&wrap=&sort=&sortDir=&filter=

Returns paginated, sorted, and filtered hits if the job belongs to a search tool. Otherwise it returns a BadRequest code.

[]

---

DELETE /api/jobs/:id/

Deletes a job.

Users (JWT, very WIP)

? /api/users/login/

Creates a user session and JWT token and returns it + user information.

{}

---

? /api/users/logout/ (possibly not necessary since the frontend just needs to forget the token to be logged out.)

---

? /api/users/register/

Allow for user registration.