Skip to content

Commit c2178da

Browse files
authored
Merge pull request #284 from BitGo/update-bitgo-api-docs
Update API reference on BitGo Developer Portal
2 parents 9df6948 + 34cf41c commit c2178da

File tree

1 file changed

+53
-3
lines changed

1 file changed

+53
-3
lines changed

api.yaml

Lines changed: 53 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -23662,6 +23662,56 @@ paths:
2366223662
$ref: '#/components/responses/NotFound'
2366323663
'500':
2366423664
$ref: '#/components/responses/ServerError'
23665+
/api/policy/v1/organizations/{organizationId}/rules:
23666+
get:
23667+
tags:
23668+
- Policy Builder
23669+
summary: List organization policy rules
23670+
description: |
23671+
Lists all policy rules for an organization.
23672+
23673+
**Authorization:** Organization admins can access their organization's rules. BitGo admins have access to all organizations.
23674+
operationId: v1.policy.organization.rules.list
23675+
parameters:
23676+
- name: organizationId
23677+
in: path
23678+
required: true
23679+
description: The organization ID
23680+
schema:
23681+
type: string
23682+
pattern: ^[0-9a-f]{32}$
23683+
- $ref: '#/components/parameters/Touchpoints1'
23684+
- $ref: '#/components/parameters/PolicyRuleStatus1'
23685+
- name: page
23686+
in: query
23687+
description: Page number (1-based)
23688+
required: false
23689+
schema:
23690+
type: integer
23691+
minimum: 1
23692+
default: 1
23693+
- name: pageSize
23694+
in: query
23695+
description: Number of results per page
23696+
required: false
23697+
schema:
23698+
type: integer
23699+
minimum: 1
23700+
maximum: 500
23701+
default: 20
23702+
responses:
23703+
'200':
23704+
description: List of organization policy rules
23705+
content:
23706+
application/json:
23707+
schema:
23708+
$ref: '#/components/schemas/PolicyRulesResults'
23709+
'401':
23710+
$ref: '#/components/responses/Unauthorized'
23711+
'404':
23712+
$ref: '#/components/responses/NotFound'
23713+
'500':
23714+
$ref: '#/components/responses/ServerError'
2366523715
/api/policy/v1/enterprises/{enterpriseId}/rules/{id}:
2366623716
get:
2366723717
tags:
@@ -26473,7 +26523,7 @@ paths:
2647326523
$ref: '#/components/schemas/StakingRewards'
2647426524
examples:
2647526525
WalletLevelRewards:
26476-
summary: Reward history aggregated at wallet level
26526+
summary: Wallet Level
2647726527
value:
2647826528
rewards:
2647926529
- reward: '1000000000000000'
@@ -26490,7 +26540,7 @@ paths:
2649026540
totalPages: 1
2649126541
totalElements: 1
2649226542
DelegationLevelRewards:
26493-
summary: Reward history aggregated at delegation level
26543+
summary: Delegation Level
2649426544
value:
2649526545
rewards:
2649626546
- reward: '1000000000000000'
@@ -26515,7 +26565,7 @@ paths:
2651526565
totalPages: 1
2651626566
totalElements: 1
2651726567
EnterpriseAccrual:
26518-
summary: Reward history aggregated at enterprise level
26568+
summary: Enterprise Level
2651926569
value:
2652026570
rewards:
2652126571
- reward: '5000000000000000'

0 commit comments

Comments
 (0)