Skip to content

Commit bb4481e

Browse files
authored
DOC: Added an API contract for /users?profile=true (#191)
* docupdate for /users?profile=true * updated the document for dev feature flag
1 parent 2f3afd8 commit bb4481e

File tree

1 file changed

+11
-0
lines changed

1 file changed

+11
-0
lines changed

users/README.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -57,6 +57,7 @@ Returns all users in the system.
5757
- **Params**
5858
None
5959
- **Query**
60+
- Optional: `profile=["true"]&dev=["true]` (if profile is set true with dev feature flag as true, it will return currently logged-in users data.)
6061
- Optional: `size=[integer]` (`size` is the number of users requested per page, value ranges between 1-100, and the default value is 100)
6162
- Optional: `page=[integer]` (`page` can either be 0 or a positive number, and the default value is 0)
6263
- Optional: `search=[string]` (`search` is a string value for username prefix)
@@ -86,6 +87,16 @@ Returns all users in the system.
8687
}
8788
```
8889
90+
**If `/users?profile=true&dev=true`**
91+
- **Code:** 200
92+
- **Content:**
93+
94+
```
95+
{
96+
<user_object>
97+
}
98+
```
99+
89100
- **Error Response:**
90101
- **Code:** 401
91102
- **Content:**

0 commit comments

Comments
 (0)