Skip to content

Commit 358dea9

Browse files
authored
Update api docs (#83)
Update api docs Description Update API docs with new implementation Reviewed-by: Vladimir Vshivkov <None> Reviewed-by: Anton Sidelnikov <None>
1 parent 13efdb0 commit 358dea9

File tree

4 files changed

+28
-425
lines changed

4 files changed

+28
-425
lines changed

doc/source/api.md

Lines changed: 26 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -133,9 +133,10 @@ $ curl \
133133
This endpoint creates or updates the role with the given `name`. If a role with the name does not exist, it will be
134134
created. If the role exists, it will be updated with the new attributes.
135135

136-
| Method | Path |
137-
|:--------|:------------------------|
138-
| `POST` | `/openstack/role/:name` |
136+
| Method | Path |
137+
|:-------|:------------------------|
138+
| `POST` | `/openstack/role/:name` |
139+
| `PUT` | `/openstack/role/:name` |
139140

140141
### Parameters
141142

@@ -371,8 +372,13 @@ $ curl \
371372
```json
372373
{
373374
"data": {
374-
"auth_url": "https://example.com/v3/",
375-
"token": "gAAAAABiA6Xfybumdwd84qvMDJKYOaauWxSvG9ItslSr5w0Mb..."
375+
"auth": {
376+
"auth_url": "https://example.com/v3/",
377+
"token": "gAAAAABiA6Xfybumdwd84qvMDJKYOaauWxSvG9ItslSr5w0Mb...",
378+
"project_name": "test",
379+
"project_domain_id": "Default"
380+
},
381+
"auth_type": "token"
376382
}
377383
}
378384
```
@@ -382,11 +388,14 @@ $ curl \
382388
```json
383389
{
384390
"data": {
385-
"auth_url": "https://example.com/v3/",
386-
"username": "admin",
387-
"password": "RcigTiYrJjVmEkrV71Cd",
388-
"project_name": "test",
389-
"project_domain_name": "Default"
391+
"auth": {
392+
"auth_url": "https://example.com/v3/",
393+
"username": "admin",
394+
"password": "RcigTiYrJjVmEkrV71Cd",
395+
"project_name": "test",
396+
"project_domain_id": "Default"
397+
},
398+
"auth_type": "password"
390399
}
391400
}
392401
```
@@ -396,10 +405,13 @@ $ curl \
396405
```json
397406
{
398407
"data": {
399-
"auth_url": "https://example.com/v3/",
400-
"username": "admin",
401-
"password": "RcigTiYrJjVmEkrV71Cd",
402-
"user_domain_name": "Default"
408+
"auth": {
409+
"auth_url": "https://example.com/v3/",
410+
"username": "admin",
411+
"password": "RcigTiYrJjVmEkrV71Cd",
412+
"user_domain_id": "Default"
413+
},
414+
"auth_type": "password"
403415
}
404416
}
405417
```

0 commit comments

Comments
 (0)