Skip to content

cleanupAPIdoc #30

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Unlock7 merged 1 commit into from
Jun 17, 2026
Merged

cleanupAPIdoc #30

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
43 changes: 22 additions & 21 deletions API_DESIGN.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -71,13 +71,13 @@ Retrieve a single user.

Update a user.

| Field | Description |
| ----------------- | -------------------------------------------- |
| **Endpoint** | /users/{id} |
| **Method** | PUT |
| **Request body** | `{ "name": "string", "email": "string" }` |
| **Response body** | `{ "message": "User Updated" } |
| **Validations** | - name ≥ 3 chars - email valid - user exists |
| Field | Description |
| ----------------- | -------------------------------------------------------- |
| **Endpoint** | /users/{id} |
| **Method** | PUT |
| **Request body** | `{ "name": "string", "email": "string" }` |
| **Response body** | `{ "id": "number", "name": "string", "email": "string"}` |
| **Validations** | - name ≥ 3 chars - email valid - user exists |

## **DELETE /users/ {id}**

Expand Down Expand Up @@ -105,13 +105,13 @@ List all projects with ticket counts.

Create a new ticket.

| Field | Description |
| ----------------- | ------------------------------------------------------------------------------------------------------------------------------------ |
| **Endpoint** | /tickets |
| **Method** | POST |
| **Request body** | `{ "title": "string", "description": "string", "projectId": number, "status": "open"}` |
| **Response body** | { "id": number, "title":"string", "description":"string", "projectId": number, "status": "open",<br /><br />createdAt": "timestamp"} |
| **Validations** | - Title required, Title  ≥ 3 chars ,  project must exists - status valid |
| Field | Description |
| ----------------- | -------------------------------------------------------------------------------------------------------------------------------------- |
| **Endpoint** | /tickets |
| **Method** | POST |
| **Request body** | `{ "title": "string", "description": "string", "projectId": number, "status": "open"}` |
| **Response body** | `{ "id": number, "title":"string", "description":"string", "projectId": number, "status": "open",<br /><br />createdAt": "timestamp"}` |
| **Validations** | - Title required, Title  ≥ 3 chars ,  project must exists - status valid |

## **GET /tickets**

Expand Down Expand Up @@ -144,13 +144,13 @@ Retrieve a single ticket.

Update ticket fields.

| Field | Description |
| ----------------- | --------------------------------------------------------------------------------------- |
| **Endpoint** | /tickets/{id} |
| **Method** | PUT |
| **Request body** | `{ "title": "string", "description": "string", "status": "type", "projectId": number }` |
| **Response body** | {**"message": "Ticket update successfully"**} |
| **Validations** | - status valid - project exists - ticket exists, email update automatically |
| Field | Description |
| ----------------- | ---------------------------------------------------------------------------------------------------------------------------------------------- |
| **Endpoint** | /tickets/{id} |
| **Method** | PUT |
| **Request body** | `{ "title": "string", "description": "string", "status": "type", "projectId": number }` |
| **Response body** | `{"id":"number", "title": "string", "description":"string", "status" "open, in progress, close", "projectId": "number", "created_at": "time"}` |
| **Validations** | - status valid - project exists - ticket exists, email update automatically |

## **POST /tickets/ {ticketId} /assignees/**

Expand Down Expand Up @@ -192,6 +192,7 @@ No emails are sent for ticket creation, ticket updates, or user removal.
### **Who receives it?**

- All assigned users of that ticket
- when ticket is updated

### What does the email contain?\*\*

Expand Down
Loading