Skip to content

Commit

Permalink
[refactor]: refactored typos
Browse files Browse the repository at this point in the history
  • Loading branch information
goodylili committed Oct 13, 2023
1 parent 2f0f49b commit 693bd72
Showing 1 changed file with 12 additions and 12 deletions.
24 changes: 12 additions & 12 deletions docs/users.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ The Users API allows for the creation, retrieval, updating, and management of us

## **Index**

- **[Endpointegers](#endpointegers)**
- **[Endpoints](#Endpoints)**
- [Create User](#create-user)
- [Retrieve User by ID](#retrieve-user-by-id)
- [Update User](#update-user)
Expand Down Expand Up @@ -35,11 +35,11 @@ The Users API allows for the creation, retrieval, updating, and management of us

---

## **Endpointegers**:
## **Endpoints**:

### <a name="create-user"></a>**1. Create User**

- **Endpointeger**: `/create`
- **Endpoint**: `/create`
- **HTTP Method**: `POST`
- **Description**: Registers a new user with the provided details.

Expand All @@ -64,7 +64,7 @@ The Users API allows for the creation, retrieval, updating, and management of us

### <a name="retrieve-user-by-id"></a>**2. Retrieve User by ID**

- **Endpointeger**: `/{id}`
- **Endpoint**: `/{id}`
- **HTTP Method**: `GET`
- **Description**: Fetches details of a specific user using their unique ID.

Expand All @@ -82,7 +82,7 @@ The Users API allows for the creation, retrieval, updating, and management of us

### <a name="update-user"></a>**3. Update User**

- **Endpointeger**: `/{id}/update`
- **Endpoint**: `/{id}/update`
- **HTTP Method**: `PUT`
- **Description**: Modifies the details of an existing user.

Expand Down Expand Up @@ -112,7 +112,7 @@ The Users API allows for the creation, retrieval, updating, and management of us

### <a name="set-user-activity-status"></a>**4. Set User Activity Status**

- **Endpointeger**: `/{id}/status`
- **Endpoint**: `/{id}/status`
- **HTTP Method**: `PUT`
- **Description**: Updates the status of a user (activate/deactivate).

Expand All @@ -139,7 +139,7 @@ The Users API allows for the creation, retrieval, updating, and management of us

### <a name="retrieve-user-by-email"></a>**5. Retrieve User by Email**

- **Endpointeger**: `/email/{email}`
- **Endpoint**: `/email/{email}`
- **HTTP Method**: `GET`
- **Description**: Fetches user details based on their email address.

Expand All @@ -158,7 +158,7 @@ The Users API allows for the creation, retrieval, updating, and management of us

### <a name="retrieve-user-by-username"></a>**6. Retrieve User by Username**

- **Endpointeger**: `/username/{username}`
- **Endpoint**: `/username/{username}`
- **HTTP Method**: `GET`
- **Description**: Fetches user details based on their username.

Expand All @@ -176,7 +176,7 @@ The Users API allows for the creation, retrieval, updating, and management of us

### <a name="retrieve-user-by-full-name"></a>**7. Retrieve User by Full Name**

- **Endpointeger**: `/fullname/{fullName}`
- **Endpoint**: `/fullname/{fullName}`
- **HTTP Method**: `GET`
- **Description**: Fetches user details based on their full name.

Expand All @@ -195,7 +195,7 @@ The Users API allows for the creation, retrieval, updating, and management of us

### <a name="change-password"></a>**8. Change Password**

- **Endpointeger**: `/password/change`
- **Endpoint**: `/password/change`
- **HTTP Method**: `PUT`
- **Description**: Changes the user's password.

Expand All @@ -219,7 +219,7 @@ The Users API allows for the creation, retrieval, updating, and management of us

### <a name="reset-password"></a>**9. Reset Password**

- **Endpointeger**: `/password/reset`
- **Endpoint**: `/password/reset`
- **HTTP Method**: `PUT`
- **Description**: Resets the user's password.

Expand All @@ -245,7 +245,7 @@ Password successfully reset.

### <a name="forgot-password"></a>**10. Forgot Password**

- **Endpointeger**: `/password/forgot`
- **Endpoint**: `/password/forgot`
- **HTTP Method**: `POST`
- **Description**: Handles the forgot password process.

Expand Down

0 comments on commit 693bd72

Please sign in to comment.