Skip to content

Commit

Permalink
Update comment to reflect new change in api token creation (#154)
Browse files Browse the repository at this point in the history
* DEV-37012: Add docs for error when updating a user with non-existent roles (#150)

* docs: Add docs for error when updating a user with non-existent roles

* docs: Move 400 response example to the update roles request

---------

Co-authored-by: Sam Ford <sam.ford@acrolinx.com>

* Update comment to reflect new change in api token creation

---------

Co-authored-by: Sam Ford <sam.ford@acrolinx.com>
  • Loading branch information
SamUK93 and Sam Ford committed Jul 23, 2024
1 parent d12177a commit 5bb1e9a
Showing 1 changed file with 5 additions and 1 deletion.
6 changes: 5 additions & 1 deletion apiary.apib
Original file line number Diff line number Diff line change
Expand Up @@ -4229,6 +4229,8 @@ Typical use cases for this API:
}
}

+ Response 403 (application/json)

// when the creator or receiver of the token is the built-in `admin`
{
"links": {},
Expand All @@ -4241,7 +4243,9 @@ Typical use cases for this API:
}
}

// when the user tries to create a token for another user with more elevated roles
+ Response 403 (application/json)

// when the user tries to create a token for a Super Administrator user, when they are not a Super Administrator themselves
{
"links": {},
"error": {
Expand Down

0 comments on commit 5bb1e9a

Please sign in to comment.