Skip to content

Commit 137bd03

Browse files
mergify[bot]glnro
andauthored
Update REST endpoints for group module documentation (#12839) (#12840)
(cherry picked from commit cfed17e) Co-authored-by: lg <8335464+glnro@users.noreply.github.com>
1 parent 2b616fb commit 137bd03

File tree

1 file changed

+30
-30
lines changed

1 file changed

+30
-30
lines changed

x/group/spec/05_client.md

Lines changed: 30 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -1037,21 +1037,21 @@ A user can query the `group` module using REST endpoints.
10371037
The `GroupInfo` endpoint allows users to query for group info by given group id.
10381038

10391039
```bash
1040-
/cosmos/group/v1beta1/group_info/{group_id}
1040+
/cosmos/group/v1/group_info/{group_id}
10411041
```
10421042

10431043
Example:
10441044

10451045
```bash
1046-
curl localhost:1317/cosmos/group/v1beta1/group_info/1
1046+
curl localhost:1317/cosmos/group/v1/group_info/1
10471047
```
10481048

10491049
Example Output:
10501050

10511051
```bash
10521052
{
10531053
"info": {
1054-
"group_id": "1",
1054+
"id": "1",
10551055
"admin": "cosmos1..",
10561056
"metadata": "AQ==",
10571057
"version": "1",
@@ -1065,13 +1065,13 @@ Example Output:
10651065
The `GroupPolicyInfo` endpoint allows users to query for group policy info by account address of group policy.
10661066

10671067
```bash
1068-
/cosmos/group/v1beta1/group_policy_info/{address}
1068+
/cosmos/group/v1/group_policy_info/{address}
10691069
```
10701070

10711071
Example:
10721072

10731073
```bash
1074-
curl localhost:1317/cosmos/group/v1beta1/group_policy_info/cosmos1..
1074+
curl localhost:1317/cosmos/group/v1/group_policy_info/cosmos1..
10751075
```
10761076

10771077
Example Output:
@@ -1101,13 +1101,13 @@ Example Output:
11011101
The `GroupMembers` endpoint allows users to query for group members by group id with pagination flags.
11021102

11031103
```bash
1104-
/cosmos/group/v1beta1/group_members/{group_id}
1104+
/cosmos/group/v1/group_members/{group_id}
11051105
```
11061106

11071107
Example:
11081108

11091109
```bash
1110-
curl localhost:1317/cosmos/group/v1beta1/group_members/1
1110+
curl localhost:1317/cosmos/group/v1/group_members/1
11111111
```
11121112

11131113
Example Output:
@@ -1143,13 +1143,13 @@ Example Output:
11431143
The `GroupsByAdmin` endpoint allows users to query for groups by admin account address with pagination flags.
11441144
11451145
```bash
1146-
/cosmos/group/v1beta1/groups_by_admin/{admin}
1146+
/cosmos/group/v1/groups_by_admin/{admin}
11471147
```
11481148
11491149
Example:
11501150
11511151
```bash
1152-
curl localhost:1317/cosmos/group/v1beta1/groups_by_admin/cosmos1..
1152+
curl localhost:1317/cosmos/group/v1/groups_by_admin/cosmos1..
11531153
```
11541154
11551155
Example Output:
@@ -1158,14 +1158,14 @@ Example Output:
11581158
{
11591159
"groups": [
11601160
{
1161-
"group_id": "1",
1161+
"id": "1",
11621162
"admin": "cosmos1..",
11631163
"metadata": "AQ==",
11641164
"version": "1",
11651165
"total_weight": "3"
11661166
},
11671167
{
1168-
"group_id": "2",
1168+
"id": "2",
11691169
"admin": "cosmos1..",
11701170
"metadata": "AQ==",
11711171
"version": "1",
@@ -1184,13 +1184,13 @@ Example Output:
11841184
The `GroupPoliciesByGroup` endpoint allows users to query for group policies by group id with pagination flags.
11851185
11861186
```bash
1187-
/cosmos/group/v1beta1/group_policies_by_group/{group_id}
1187+
/cosmos/group/v1/group_policies_by_group/{group_id}
11881188
```
11891189
11901190
Example:
11911191
11921192
```bash
1193-
curl localhost:1317/cosmos/group/v1beta1/group_policies_by_group/1
1193+
curl localhost:1317/cosmos/group/v1/group_policies_by_group/1
11941194
```
11951195
11961196
Example Output:
@@ -1241,13 +1241,13 @@ Example Output:
12411241
The `GroupPoliciesByAdmin` endpoint allows users to query for group policies by admin account address with pagination flags.
12421242
12431243
```bash
1244-
/cosmos/group/v1beta1/group_policies_by_admin/{admin}
1244+
/cosmos/group/v1/group_policies_by_admin/{admin}
12451245
```
12461246
12471247
Example:
12481248
12491249
```bash
1250-
curl localhost:1317/cosmos/group/v1beta1/group_policies_by_admin/cosmos1..
1250+
curl localhost:1317/cosmos/group/v1/group_policies_by_admin/cosmos1..
12511251
```
12521252
12531253
Example Output:
@@ -1267,7 +1267,7 @@ Example Output:
12671267
"windows": {
12681268
"voting_period": "120h",
12691269
"min_execution_period": "0s"
1270-
}
1270+
}
12711271
},
12721272
},
12731273
{
@@ -1297,13 +1297,13 @@ Example Output:
12971297
The `Proposal` endpoint allows users to query for proposal by id.
12981298
12991299
```bash
1300-
/cosmos/group/v1beta1/proposal/{proposal_id}
1300+
/cosmos/group/v1/proposal/{proposal_id}
13011301
```
13021302
13031303
Example:
13041304
13051305
```bash
1306-
curl localhost:1317/cosmos/group/v1beta1/proposal/1
1306+
curl localhost:1317/cosmos/group/v1/proposal/1
13071307
```
13081308
13091309
Example Output:
@@ -1355,13 +1355,13 @@ Example Output:
13551355
The `ProposalsByGroupPolicy` endpoint allows users to query for proposals by account address of group policy with pagination flags.
13561356
13571357
```bash
1358-
/cosmos/group/v1beta1/proposals_by_group_policy/{address}
1358+
/cosmos/group/v1/proposals_by_group_policy/{address}
13591359
```
13601360
13611361
Example:
13621362
13631363
```bash
1364-
curl localhost:1317/cosmos/group/v1beta1/proposals_by_group_policy/cosmos1..
1364+
curl localhost:1317/cosmos/group/v1/proposals_by_group_policy/cosmos1..
13651365
```
13661366
13671367
Example Output:
@@ -1370,13 +1370,13 @@ Example Output:
13701370
{
13711371
"proposals": [
13721372
{
1373-
"proposal_id": "1",
1374-
"address": "cosmos1..",
1373+
"id": "1",
1374+
"group_policy_address": "cosmos1..",
13751375
"metadata": "AQ==",
13761376
"proposers": [
13771377
"cosmos1.."
13781378
],
1379-
"submitted_at": "2021-12-17T08:03:27.099649352Z",
1379+
"submit_time": "2021-12-17T08:03:27.099649352Z",
13801380
"group_version": "1",
13811381
"group_policy_version": "1",
13821382
"status": "STATUS_CLOSED",
@@ -1419,7 +1419,7 @@ Example Output:
14191419
The `VoteByProposalVoter` endpoint allows users to query for vote by proposal id and voter account address.
14201420
14211421
```bash
1422-
/cosmos/group/v1beta1/vote_by_proposal_voter/{proposal_id}/{voter}
1422+
/cosmos/group/v1/vote_by_proposal_voter/{proposal_id}/{voter}
14231423
```
14241424
14251425
Example:
@@ -1447,13 +1447,13 @@ Example Output:
14471447
The `VotesByProposal` endpoint allows users to query for votes by proposal id with pagination flags.
14481448
14491449
```bash
1450-
/cosmos/group/v1beta1/votes_by_proposal/{proposal_id}
1450+
/cosmos/group/v1/votes_by_proposal/{proposal_id}
14511451
```
14521452
14531453
Example:
14541454
14551455
```bash
1456-
curl localhost:1317/cosmos/group/v1beta1/votes_by_proposal/1
1456+
curl localhost:1317/cosmos/group/v1/votes_by_proposal/1
14571457
```
14581458
14591459
Example Output:
@@ -1464,9 +1464,9 @@ Example Output:
14641464
{
14651465
"proposal_id": "1",
14661466
"voter": "cosmos1..",
1467-
"choice": "CHOICE_YES",
1467+
"option": "CHOICE_YES",
14681468
"metadata": "AQ==",
1469-
"submitted_at": "2021-12-17T08:05:02.490164009Z"
1469+
"submit_time": "2021-12-17T08:05:02.490164009Z"
14701470
}
14711471
],
14721472
"pagination": {
@@ -1481,13 +1481,13 @@ Example Output:
14811481
The `VotesByVoter` endpoint allows users to query for votes by voter account address with pagination flags.
14821482
14831483
```bash
1484-
/cosmos/group/v1beta1/votes_by_voter/{voter}
1484+
/cosmos/group/v1/votes_by_voter/{voter}
14851485
```
14861486
14871487
Example:
14881488
14891489
```bash
1490-
curl localhost:1317/cosmos/group/v1beta1/votes_by_voter/cosmos1..
1490+
curl localhost:1317/cosmos/group/v1/votes_by_voter/cosmos1..
14911491
```
14921492
14931493
Example Output:

0 commit comments

Comments
 (0)