Skip to content

Commit bdad70d

Browse files
HTTP API reference updates for rabbitmqadmin 2.1.0
1 parent 4b2636a commit bdad70d

File tree

3 files changed

+78
-9
lines changed

3 files changed

+78
-9
lines changed

docs/http-api-reference.md

Lines changed: 26 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1265,6 +1265,11 @@ Deletes a [runtime parameter](./parameters).
12651265
Lists all [global runtime parameters](./parameters) in the cluster.
12661266

12671267
<Tabs groupId="examples">
1268+
<TabItem value="rabbitmqadmin" label="rabbitmqadmin v2">
1269+
```bash
1270+
rabbitmqadmin global_parameters list
1271+
```
1272+
</TabItem>
12681273
<TabItem value="curl" label="curl" default>
12691274
```bash
12701275
curl -sL -u guest:guest -H "Accept: application/json" http://127.0.0.1:15672/api/global-parameters
@@ -1302,20 +1307,38 @@ Example payloads:
13021307
"name": "cluster_tags",
13031308
"value": {
13041309
"environment": "production",
1305-
"az": "us-east-3",
1306-
"region": "us-east"
1310+
"az": "ca-central-1"
13071311
}
13081312
}
13091313
```
13101314

1315+
<Tabs groupId="examples">
1316+
<TabItem value="rabbitmqadmin" label="rabbitmqadmin v2">
1317+
```bash
1318+
rabbitmqadmin global_parameters set --name "cluster_tags" --value '{"az": "ca-central-1", "environment": "production"}'
1319+
```
1320+
</TabItem>
1321+
<TabItem value="curl" label="curl" default>
1322+
```bash
1323+
curl -sL -u guest:guest -X PUT -H "Accept: application/json" -H "Content-Type: application/json" http://127.0.0.1:15672/api/global-parameters/cluster_tags \
1324+
--data '{"value": {"region": "ca-central-1", "environment": "production"}, "name": "cluster_tags"}'
1325+
```
1326+
</TabItem>
1327+
</Tabs>
1328+
13111329
### DELETE /api/global-parameters/\{_name_\}
13121330

13131331
Clears a global runtime parameter.
13141332

13151333
<Tabs groupId="examples">
1334+
<TabItem value="rabbitmqadmin" label="rabbitmqadmin v2">
1335+
```bash
1336+
rabbitmqadmin global_parameters clear --name "cluster_tags"
1337+
```
1338+
</TabItem>
13161339
<TabItem value="curl" label="curl" default>
13171340
```bash
1318-
curl -sL -u guest:guest -X DELETE -H "Accept: application/json" http://127.0.0.1:15672/api/global-parameters/cluster_name
1341+
curl -sL -u guest:guest -X DELETE -H "Accept: application/json" http://127.0.0.1:15672/api/global-parameters/cluster_tags
13191342
```
13201343
</TabItem>
13211344
</Tabs>

versioned_docs/version-4.0/http-api-reference.md

Lines changed: 26 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1265,6 +1265,11 @@ Deletes a [runtime parameter](./parameters).
12651265
Lists all [global runtime parameters](./parameters) in the cluster.
12661266

12671267
<Tabs groupId="examples">
1268+
<TabItem value="rabbitmqadmin" label="rabbitmqadmin v2">
1269+
```bash
1270+
rabbitmqadmin global_parameters list
1271+
```
1272+
</TabItem>
12681273
<TabItem value="curl" label="curl" default>
12691274
```bash
12701275
curl -sL -u guest:guest -H "Accept: application/json" http://127.0.0.1:15672/api/global-parameters
@@ -1302,20 +1307,38 @@ Example payloads:
13021307
"name": "cluster_tags",
13031308
"value": {
13041309
"environment": "production",
1305-
"az": "us-east-3",
1306-
"region": "us-east"
1310+
"az": "ca-central-1"
13071311
}
13081312
}
13091313
```
13101314

1315+
<Tabs groupId="examples">
1316+
<TabItem value="rabbitmqadmin" label="rabbitmqadmin v2">
1317+
```bash
1318+
rabbitmqadmin global_parameters set --name "cluster_tags" --value '{"az": "ca-central-1", "environment": "production"}'
1319+
```
1320+
</TabItem>
1321+
<TabItem value="curl" label="curl" default>
1322+
```bash
1323+
curl -sL -u guest:guest -X PUT -H "Accept: application/json" -H "Content-Type: application/json" http://127.0.0.1:15672/api/global-parameters/cluster_tags \
1324+
--data '{"value": {"region": "ca-central-1", "environment": "production"}, "name": "cluster_tags"}'
1325+
```
1326+
</TabItem>
1327+
</Tabs>
1328+
13111329
### DELETE /api/global-parameters/\{_name_\}
13121330

13131331
Clears a global runtime parameter.
13141332

13151333
<Tabs groupId="examples">
1334+
<TabItem value="rabbitmqadmin" label="rabbitmqadmin v2">
1335+
```bash
1336+
rabbitmqadmin global_parameters clear --name "cluster_tags"
1337+
```
1338+
</TabItem>
13161339
<TabItem value="curl" label="curl" default>
13171340
```bash
1318-
curl -sL -u guest:guest -X DELETE -H "Accept: application/json" http://127.0.0.1:15672/api/global-parameters/cluster_name
1341+
curl -sL -u guest:guest -X DELETE -H "Accept: application/json" http://127.0.0.1:15672/api/global-parameters/cluster_tags
13191342
```
13201343
</TabItem>
13211344
</Tabs>

versioned_docs/version-4.1/http-api-reference.md

Lines changed: 26 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1265,6 +1265,11 @@ Deletes a [runtime parameter](./parameters).
12651265
Lists all [global runtime parameters](./parameters) in the cluster.
12661266

12671267
<Tabs groupId="examples">
1268+
<TabItem value="rabbitmqadmin" label="rabbitmqadmin v2">
1269+
```bash
1270+
rabbitmqadmin global_parameters list
1271+
```
1272+
</TabItem>
12681273
<TabItem value="curl" label="curl" default>
12691274
```bash
12701275
curl -sL -u guest:guest -H "Accept: application/json" http://127.0.0.1:15672/api/global-parameters
@@ -1302,20 +1307,38 @@ Example payloads:
13021307
"name": "cluster_tags",
13031308
"value": {
13041309
"environment": "production",
1305-
"az": "us-east-3",
1306-
"region": "us-east"
1310+
"az": "ca-central-1"
13071311
}
13081312
}
13091313
```
13101314

1315+
<Tabs groupId="examples">
1316+
<TabItem value="rabbitmqadmin" label="rabbitmqadmin v2">
1317+
```bash
1318+
rabbitmqadmin global_parameters set --name "cluster_tags" --value '{"az": "ca-central-1", "environment": "production"}'
1319+
```
1320+
</TabItem>
1321+
<TabItem value="curl" label="curl" default>
1322+
```bash
1323+
curl -sL -u guest:guest -X PUT -H "Accept: application/json" -H "Content-Type: application/json" http://127.0.0.1:15672/api/global-parameters/cluster_tags \
1324+
--data '{"value": {"region": "ca-central-1", "environment": "production"}, "name": "cluster_tags"}'
1325+
```
1326+
</TabItem>
1327+
</Tabs>
1328+
13111329
### DELETE /api/global-parameters/\{_name_\}
13121330

13131331
Clears a global runtime parameter.
13141332

13151333
<Tabs groupId="examples">
1334+
<TabItem value="rabbitmqadmin" label="rabbitmqadmin v2">
1335+
```bash
1336+
rabbitmqadmin global_parameters clear --name "cluster_tags"
1337+
```
1338+
</TabItem>
13161339
<TabItem value="curl" label="curl" default>
13171340
```bash
1318-
curl -sL -u guest:guest -X DELETE -H "Accept: application/json" http://127.0.0.1:15672/api/global-parameters/cluster_name
1341+
curl -sL -u guest:guest -X DELETE -H "Accept: application/json" http://127.0.0.1:15672/api/global-parameters/cluster_tags
13191342
```
13201343
</TabItem>
13211344
</Tabs>

0 commit comments

Comments
 (0)