DevDesk Node Backend

Schema

View on DB Designer

API Endpoints

Deployed to Heroku: https://devdeskqueue3-pt.herokuapp.com/

All endpoints receive and return JSON

Auth

Method	URL	Description
POST	/api/auth/login	Login endpoint for registered users
POST	/api/auth/register	Register endpoint for new users

---

POST /api/auth/login

Receives

{
    "email": "alice@gmail.com",
    "password": "hello"
}

Returns

{
    "id": 5,
    "name": "Alice",
    "email": "alice@gmail.com",
    "roles": [
        "STUDENT"
    ],
    "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6NSwibmFtZSI6IkFsaWNlIiwiZW1haWwiOiJhbGljZUBnbWFpbC5jb20iLCJyb2xlcyI6WyJTVFVERU5UIl0sImlhdCI6MTU5MjYxODM4MiwiZXhwIjoxNTkyNjI1NTgyfQ.JCn_0iOCptEmJ7xIKBf4tOPHZanncar719n0mGdHiI8"
}

---

POST /api/auth/register

Receives

{
    "name": "Alice",
    "password": "hello",
    "email": "alice@gmail.com",
    "roles": ["STUDENT"]
}

Returns

{
    "id": 5,
    "name": "Alice",
    "email": "alice@gmail.com",
    "roles": [
        "STUDENT"
    ],
    "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6NSwibmFtZSI6IkFsaWNlIiwiZW1haWwiOiJhbGljZUBnbWFpbC5jb20iLCJyb2xlcyI6WyJTVFVERU5UIl0sImlhdCI6MTU5MjYxMTQyNSwiZXhwIjoxNTkyNjE4NjI1fQ.WsufM68xVT-DcEbfyOBFwq_VC-6Xjr5wc4-ktgO3mxo"
}

---

Tickets

Method	URL	Description
GET	/api/tickets	Returns an array of all tickets, or filtered by status and/or associated users
POST	/api/tickets	Creates a new ticket for the logged in user. Returns the ticket
PUT	/api/tickets/:id	Updates an existing ticket belonging to the logged in user. Returns the ticket
DELETE	/api/tickets/:id	Deletes a ticket by ID
PATCH	/api/tickets/:id/claim	Claim a ticket belonging to another user
PATCH	/api/tickets/:id/release	Release a ticket the logged in user has already claimed
PATCH	/api/tickets/:id/open	Mark a ticket as OPEN
PATCH	/api/tickets/:id/close	Mark a ticket as CLOSED
PATCH	/api/tickets/:id/resolve	Mark a ticket as RESOLVED

---

GET /api/tickets

GET /api/tickets?status=OPEN

GET /api/tickets?status=CLOSED

GET /api/tickets?status=RESOLVED

GET /api/tickets?claimed=TRUE

GET /api/tickets?claimed=FALSE

GET /api/tickets?claimed_by=USER_ID

GET /api/tickets?posted_by=USER_ID

Returns an array of tickets according to the applied filters

[
    {
    "ticket_id": 3,
    "posted_by_id": 2,
    "posted_by_name": "testuser2",
    "posted_at": "2020-06-23T01:49:29.454Z",
    "status": "OPEN",
    "title": "Ticket 3",
    "description": "Ticket 3 description text ",
    "categories": [
        "CSS",
        "HTML",
        "React"
    ],
    "claimed_by_id": 1,
    "claimed_by_name": "testuser1"
    }
]

---

POST /api/tickets

Receives

{
    "title": "new ticket!",
    "description": "here's the description",
    "what_ive_tried": "here's what I've tried",
    "categories": ["category 1", "category 2", "category 3"]
}

Returns

{
    "ticket_id": 42,
    "posted_by_id": 5,
    "posted_by_name": "Alice",
    "posted_at": "2020-06-23T04:54:54.063Z",
    "status": "OPEN",
    "title": "new ticket!",
    "description": "here's the description",
    "what_ive_tried": "here's what I've tried",
    "categories": [
        "category 1",
        "category 2",
        "category 3"
    ],
    "claimed_by_id": null,
    "claimed_by_name": null
}

---

PUT /api/tickets/:id

Receives

{
    "title": "updated ticket!",
    "description": "here's the description",
    "what_ive_tried": "here's what I've tried",
    "categories": ["new category", "category 2", "category 3"]
}

Returns

{
    "ticket_id": 42,
    "posted_by_id": 5,
    "posted_by_name": "Alice",
    "posted_at": "2020-06-23T04:53:53.770Z",
    "status": "OPEN",
    "title": "updated ticket!",
    "description": "here's the description",
    "what_ive_tried": "here's what I've tried",
    "categories": [
        "new category",
        "category 2",
        "category 3"
    ],
    "claimed_by_id": null,
    "claimed_by_name": null
}

---

PATCH /api/tickets/:id/claim

Returns

{
    "ticket_id": 1,
    "claimed_by": 5,
    "status": "OPEN"
}

---

PATCH /api/tickets/:id/release

Returns

{
    "ticket_id": 1,
    "claimed_by": null,
    "status": "OPEN"
}

---

PATCH /api/tickets/:id/open

Returns

{
    "ticket_id": 1,
    "claimed_by": null,
    "status": "OPEN"
}

---

PATCH /api/tickets/:id/close

Returns

{
    "ticket_id": 1,
    "claimed_by": null,
    "status": "CLOSED"
}

---

PATCH /api/tickets/:id/resolve

Returns

{
    "ticket_id": 1,
    "claimed_by": null,
    "status": "RESOLVED"
}

---

Users

Method	URL	Description
GET	/api/users/:id	Returns profile info for user by id
PUT	/api/users/:id	Updates user and roles for user with id. Users can only update their own data

---

GET /api/users/:id

Returns

{
    "id": 7,
    "name": "Bob",
    "email": "bob@gmail.com",
    "roles": [
        "STUDENT"
    ]
}

---

PUT /api/users/:id

Receives (fields that do not change can be omitted)

{
    "name": "Bobby",
    "password": "newpassword42",
    "roles": ["STUDENT", "HELPER"]
}

Returns

{
    "id": 7,
    "name": "Bobby",
    "email": "bob@gmail.com",
    "roles": [
        "STUDENT",
        "HELPER"
    ]
}