Update REST-API documentation

The /users/inet endpoint now supports PATCH.
This commit is contained in:
Markus Mäkelä 2019-06-25 08:29:44 +03:00
parent 8568822da2
commit 60d2bfc538
No known key found for this signature in database
GPG Key ID: 72D48FCE664F7B19

View File

@ -282,3 +282,31 @@ The _:name_ part of the URI must be a valid user name.
```
Status: 204 No Content
```
### Update a network user
```
PATCH /v1/users/inet/:name
```
Update network user. Currently, only the password can be updated. This
means that the request body must define the `data.attributes.password`
field.
Here is an example request body that updates the password.
```javascript
{
"data": {
"attributes": {
"password": "new-password"
}
}
}
```
#### Response
```
Status: 204 No Content
```