Skip to content

Commit a7ba0b7

Browse files
authored
Minor changes (#91)
Update `api.md` documentation Description Add missing PUT method in cloud path Resolves: #89 Reviewed-by: Anton Sidelnikov <None>
1 parent dcb9441 commit a7ba0b7

File tree

1 file changed

+17
-12
lines changed

1 file changed

+17
-12
lines changed

doc/source/api.md

Lines changed: 17 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -7,9 +7,10 @@
77
This endpoint configures the root credentials to communicate with OpenStack instance. If credentials already exist, this
88
will overwrite them.
99

10-
| Method | Path |
11-
|:---------|:--------------------------|
12-
| `POST` | `/openstack/cloud/:cloud` |
10+
| Method | Path |
11+
|:-------|:--------------------------|
12+
| `POST` | `/openstack/cloud/:cloud` |
13+
| `PUT` | `/openstack/cloud/:cloud` |
1314

1415
### Parameters
1516

@@ -21,12 +22,12 @@ will overwrite them.
2122

2223
* `password` `(string: <required>)` - OpenStack password of the root user.
2324

24-
* `username_template` `(string: "vault{{random 8 | lowercase}}")` - Template used for usernames
25-
of temporary users. For details on templating syntax please refer to
26-
[Username Templating](https://www.vaultproject.io/docs/concepts/username-templating). Additional
25+
* `username_template` `(string: "vault{{random 8 | lowercase}}")` - Template used for usernames
26+
of temporary users. For details on templating syntax please refer to
27+
[Username Templating](https://www.vaultproject.io/docs/concepts/username-templating). Additional
2728
fields available for the template are `.CloudName`, `.RoleName`.
2829

29-
* `password_policy` `(string: <optional>)` - Specifies a password policy name to use when creating dynamic credentials.
30+
* `password_policy` `(string: <optional>)` - Specifies a password policy name to use when creating dynamic credentials.
3031
Defaults to generating an alphanumeric password if not set. For details on password policies please refer
3132
to [Password Policies](https://www.vaultproject.io/docs/concepts/password-policies).
3233

@@ -103,7 +104,10 @@ $ curl \
103104
```json
104105
{
105106
"data": {
106-
"keys": ["sample-cloud-1", "sample-cloud-2"]
107+
"keys": [
108+
"sample-cloud-1",
109+
"sample-cloud-2"
110+
]
107111
}
108112
}
109113
```
@@ -249,7 +253,7 @@ $ curl \
249253
}
250254
```
251255

252-
or
256+
or
253257

254258
```json
255259
{
@@ -274,7 +278,6 @@ This endpoint queries an existing role by the given name. If the role does not e
274278
|:---------|:------------------------|
275279
| `GET` | `/openstack/role/:name` |
276280

277-
278281
### Parameters
279282

280283
- `name` `(string: <required>)` – Specifies the name of the role to read. This is part of the request URL.
@@ -313,7 +316,6 @@ This endpoint queries an existing role by the given name. If the role does not e
313316
| `LIST` | `/openstack/roles` |
314317
| `GET` | `/openstack/roles` |
315318

316-
317319
### Parameters
318320

319321
- `cloud` `(string: <optional>)` – Specifies the name of the role to read. This is part of the request URL.
@@ -341,7 +343,10 @@ $ curl \
341343
```json
342344
{
343345
"data": {
344-
"keys": ["default-cloud-role-1", "default-cloud-role-2"]
346+
"keys": [
347+
"default-cloud-role-1",
348+
"default-cloud-role-2"
349+
]
345350
}
346351
}
347352
```

0 commit comments

Comments
 (0)