Skip to content

Commit

Permalink
DOC: Added an API contract for /users?profile=true (#191)
Browse files Browse the repository at this point in the history
* docupdate for /users?profile=true

* updated the document for dev feature flag
  • Loading branch information
vikasosmium authored Oct 15, 2024
1 parent 2f3afd8 commit bb4481e
Showing 1 changed file with 11 additions and 0 deletions.
11 changes: 11 additions & 0 deletions users/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -57,6 +57,7 @@ Returns all users in the system.
- **Params**
None
- **Query**
- Optional: `profile=["true"]&dev=["true]` (if profile is set true with dev feature flag as true, it will return currently logged-in users data.)
- Optional: `size=[integer]` (`size` is the number of users requested per page, value ranges between 1-100, and the default value is 100)
- Optional: `page=[integer]` (`page` can either be 0 or a positive number, and the default value is 0)
- Optional: `search=[string]` (`search` is a string value for username prefix)
Expand Down Expand Up @@ -86,6 +87,16 @@ Returns all users in the system.
}
```
**If `/users?profile=true&dev=true`**
- **Code:** 200
- **Content:**
```
{
<user_object>
}
```
- **Error Response:**
- **Code:** 401
- **Content:**
Expand Down

0 comments on commit bb4481e

Please sign in to comment.