Endpoint

<Endpoint method="GET" path="/api/users/:id" description="get a user by id">
  <Param name="id" type="string" required description="the user id" />
</Endpoint>

<Endpoint method="POST" path="/api/users" description="create a new user">
  <Param name="name" type="string" required description="user's full name" />
  <Param
    name="email"
    type="string"
    required
    description="user's email address"
  />
  <Param name="role" type="string" description="user role (admin, user)" />
</Endpoint>

<Response status={200} description="success">
  returns the user object
</Response>

<Response status={404} description="not found">
  user does not exist
</Response>