Skip to content

Commit

Permalink
added one api contract
Browse files Browse the repository at this point in the history
  • Loading branch information
vikasosmium committed Dec 12, 2024
1 parent 829479e commit 646be70
Showing 1 changed file with 104 additions and 0 deletions.
104 changes: 104 additions & 0 deletions users/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -489,3 +489,107 @@ Archive users if not in Discord.
"message": "An internal server error occurred"
}
```

## PUT /users/:userId/intro

Creating a User Intro in DB if not available

- **Params**
None
- **Query**
None
- **Headers**
Content-Type: application/json
- **Cookie**
rds-session: `<JWT>`
- **Body**

```json
{
"firstName": string,
"lastName": string,
"college": string,
"skills": string,
"city": string,
"state": string,
"country": string,
"foundFrom": string,
"introduction": string,
"funFact": string,
"whyRds": string,
"flowState": string,
"numberOfHours": number
}
```

- **Success Response:**
- **Code:** 201
- **Content:**

```json
{
"message": "User join data and newstatus data added and updated successfully"
}
```

- **Error Response:**

- **Code:** 400

- **Content:**

```json
{
"statusCode": 400,
"error": "Bad Request",
"message": "{key} is required"
}
```

- **Code:** 401

- **Content:**

```json
{
"statusCode": 401,
"error": "Unauthorized",
"message": "Unauthenticated User"
}
```

- **Code:** 403

- **Content:**

```json
{
"statusCode": 403,
"error": "Forbidden",
"message": "Forbidden access"
}
```

- **Code:** 409

- **Content:**

```json
{
"statusCode": 409,
"error": "Conflict",
"message": "User data is already present!"
}
```

- **Code:** 500

- **Content:**

```json
{
"statusCode": 500,
"error": "Internal Server Error",
"message": "An internal server error occurred"
}
```

0 comments on commit 646be70

Please sign in to comment.