platform-api 1.0.1 → 2.0.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/Gemfile.lock +4 -4
- data/README.md +3 -1
- data/config/client-config.rb +5 -1
- data/lib/platform-api/client.rb +10541 -7810
- data/lib/platform-api/schema.json +12390 -2294
- data/lib/platform-api/version.rb +1 -1
- data/platform-api.gemspec +1 -1
- data/schema.json +2418 -226
- metadata +5 -5
data/lib/platform-api/version.rb
CHANGED
data/platform-api.gemspec
CHANGED
|
@@ -26,6 +26,6 @@ Gem::Specification.new do |spec|
|
|
|
26
26
|
spec.add_development_dependency 'netrc'
|
|
27
27
|
spec.add_development_dependency 'rspec'
|
|
28
28
|
|
|
29
|
-
spec.add_dependency 'heroics', '~> 0.0.
|
|
29
|
+
spec.add_dependency 'heroics', '~> 0.0.22'
|
|
30
30
|
spec.add_dependency 'moneta', '~> 0.8.1'
|
|
31
31
|
end
|
data/schema.json
CHANGED
|
@@ -90,6 +90,22 @@
|
|
|
90
90
|
"type": [
|
|
91
91
|
"string"
|
|
92
92
|
]
|
|
93
|
+
},
|
|
94
|
+
"display_name": {
|
|
95
|
+
"description": "user readable feature name",
|
|
96
|
+
"example": "My Feature",
|
|
97
|
+
"readOnly": true,
|
|
98
|
+
"type": [
|
|
99
|
+
"string"
|
|
100
|
+
]
|
|
101
|
+
},
|
|
102
|
+
"feedback_email": {
|
|
103
|
+
"description": "e-mail to send feedback about the feature",
|
|
104
|
+
"example": "feedback@heroku.com",
|
|
105
|
+
"readOnly": true,
|
|
106
|
+
"type": [
|
|
107
|
+
"string"
|
|
108
|
+
]
|
|
93
109
|
}
|
|
94
110
|
},
|
|
95
111
|
"links": [
|
|
@@ -166,6 +182,12 @@
|
|
|
166
182
|
},
|
|
167
183
|
"updated_at": {
|
|
168
184
|
"$ref": "#/definitions/account-feature/definitions/updated_at"
|
|
185
|
+
},
|
|
186
|
+
"display_name": {
|
|
187
|
+
"$ref": "#/definitions/account-feature/definitions/display_name"
|
|
188
|
+
},
|
|
189
|
+
"feedback_email": {
|
|
190
|
+
"$ref": "#/definitions/account-feature/definitions/feedback_email"
|
|
169
191
|
}
|
|
170
192
|
}
|
|
171
193
|
},
|
|
@@ -394,7 +416,7 @@
|
|
|
394
416
|
"targetSchema": {
|
|
395
417
|
"$ref": "#/definitions/account"
|
|
396
418
|
},
|
|
397
|
-
"title": "Info"
|
|
419
|
+
"title": "Info By User"
|
|
398
420
|
},
|
|
399
421
|
{
|
|
400
422
|
"description": "Update account.",
|
|
@@ -420,7 +442,7 @@
|
|
|
420
442
|
"targetSchema": {
|
|
421
443
|
"$ref": "#/definitions/account"
|
|
422
444
|
},
|
|
423
|
-
"title": "Update"
|
|
445
|
+
"title": "Update By User"
|
|
424
446
|
},
|
|
425
447
|
{
|
|
426
448
|
"description": "Delete account. Note that this action cannot be undone.",
|
|
@@ -430,7 +452,7 @@
|
|
|
430
452
|
"targetSchema": {
|
|
431
453
|
"$ref": "#/definitions/account"
|
|
432
454
|
},
|
|
433
|
-
"title": "Delete"
|
|
455
|
+
"title": "Delete By User"
|
|
434
456
|
}
|
|
435
457
|
],
|
|
436
458
|
"properties": {
|
|
@@ -536,7 +558,7 @@
|
|
|
536
558
|
"targetSchema": {
|
|
537
559
|
"$ref": "#/definitions/add-on"
|
|
538
560
|
},
|
|
539
|
-
"title": "
|
|
561
|
+
"title": "Provision"
|
|
540
562
|
},
|
|
541
563
|
{
|
|
542
564
|
"description": "Mark an add-on as deprovisioned.",
|
|
@@ -546,7 +568,7 @@
|
|
|
546
568
|
"targetSchema": {
|
|
547
569
|
"$ref": "#/definitions/add-on"
|
|
548
570
|
},
|
|
549
|
-
"title": "
|
|
571
|
+
"title": "Deprovision"
|
|
550
572
|
}
|
|
551
573
|
],
|
|
552
574
|
"properties": {
|
|
@@ -614,6 +636,15 @@
|
|
|
614
636
|
"string"
|
|
615
637
|
]
|
|
616
638
|
},
|
|
639
|
+
"namespace": {
|
|
640
|
+
"description": "attachment namespace",
|
|
641
|
+
"example": "role:analytics",
|
|
642
|
+
"readOnly": true,
|
|
643
|
+
"type": [
|
|
644
|
+
"null",
|
|
645
|
+
"string"
|
|
646
|
+
]
|
|
647
|
+
},
|
|
617
648
|
"updated_at": {
|
|
618
649
|
"description": "when add-on attachment was updated",
|
|
619
650
|
"example": "2012-01-01T12:00:00Z",
|
|
@@ -653,6 +684,9 @@
|
|
|
653
684
|
},
|
|
654
685
|
"name": {
|
|
655
686
|
"$ref": "#/definitions/add-on-attachment/definitions/name"
|
|
687
|
+
},
|
|
688
|
+
"namespace": {
|
|
689
|
+
"$ref": "#/definitions/add-on-attachment/definitions/namespace"
|
|
656
690
|
}
|
|
657
691
|
},
|
|
658
692
|
"required": [
|
|
@@ -819,6 +853,9 @@
|
|
|
819
853
|
"name": {
|
|
820
854
|
"$ref": "#/definitions/add-on-attachment/definitions/name"
|
|
821
855
|
},
|
|
856
|
+
"namespace": {
|
|
857
|
+
"$ref": "#/definitions/add-on-attachment/definitions/namespace"
|
|
858
|
+
},
|
|
822
859
|
"updated_at": {
|
|
823
860
|
"$ref": "#/definitions/add-on-attachment/definitions/updated_at"
|
|
824
861
|
},
|
|
@@ -897,6 +934,9 @@
|
|
|
897
934
|
]
|
|
898
935
|
},
|
|
899
936
|
"targetSchema": {
|
|
937
|
+
"type": [
|
|
938
|
+
"array"
|
|
939
|
+
],
|
|
900
940
|
"items": {
|
|
901
941
|
"$ref": "#/definitions/add-on-config"
|
|
902
942
|
}
|
|
@@ -1060,7 +1100,7 @@
|
|
|
1060
1100
|
"array"
|
|
1061
1101
|
]
|
|
1062
1102
|
},
|
|
1063
|
-
"title": "List"
|
|
1103
|
+
"title": "List By Region"
|
|
1064
1104
|
}
|
|
1065
1105
|
],
|
|
1066
1106
|
"properties": {
|
|
@@ -1374,6 +1414,31 @@
|
|
|
1374
1414
|
}
|
|
1375
1415
|
},
|
|
1376
1416
|
"links": [
|
|
1417
|
+
{
|
|
1418
|
+
"description": "List all existing add-ons.",
|
|
1419
|
+
"href": "/addons",
|
|
1420
|
+
"method": "GET",
|
|
1421
|
+
"rel": "instances",
|
|
1422
|
+
"targetSchema": {
|
|
1423
|
+
"items": {
|
|
1424
|
+
"$ref": "#/definitions/add-on"
|
|
1425
|
+
},
|
|
1426
|
+
"type": [
|
|
1427
|
+
"array"
|
|
1428
|
+
]
|
|
1429
|
+
},
|
|
1430
|
+
"title": "List"
|
|
1431
|
+
},
|
|
1432
|
+
{
|
|
1433
|
+
"description": "Info for an existing add-on.",
|
|
1434
|
+
"href": "/addons/{(%23%2Fdefinitions%2Fadd-on%2Fdefinitions%2Fidentity)}",
|
|
1435
|
+
"method": "GET",
|
|
1436
|
+
"rel": "self",
|
|
1437
|
+
"targetSchema": {
|
|
1438
|
+
"$ref": "#/definitions/add-on"
|
|
1439
|
+
},
|
|
1440
|
+
"title": "Info"
|
|
1441
|
+
},
|
|
1377
1442
|
{
|
|
1378
1443
|
"description": "Create a new add-on.",
|
|
1379
1444
|
"href": "/apps/{(%23%2Fdefinitions%2Fapp%2Fdefinitions%2Fidentity)}/addons",
|
|
@@ -1444,11 +1509,11 @@
|
|
|
1444
1509
|
"targetSchema": {
|
|
1445
1510
|
"$ref": "#/definitions/add-on"
|
|
1446
1511
|
},
|
|
1447
|
-
"title": "Info"
|
|
1512
|
+
"title": "Info By App"
|
|
1448
1513
|
},
|
|
1449
1514
|
{
|
|
1450
|
-
"description": "List
|
|
1451
|
-
"href": "/addons",
|
|
1515
|
+
"description": "List existing add-ons for an app.",
|
|
1516
|
+
"href": "/apps/{(%23%2Fdefinitions%2Fapp%2Fdefinitions%2Fidentity)}/addons",
|
|
1452
1517
|
"method": "GET",
|
|
1453
1518
|
"rel": "instances",
|
|
1454
1519
|
"targetSchema": {
|
|
@@ -1459,17 +1524,27 @@
|
|
|
1459
1524
|
"array"
|
|
1460
1525
|
]
|
|
1461
1526
|
},
|
|
1462
|
-
"title": "List"
|
|
1527
|
+
"title": "List By App"
|
|
1463
1528
|
},
|
|
1464
1529
|
{
|
|
1465
|
-
"description": "
|
|
1466
|
-
"href": "/addons/{(%23%2Fdefinitions%2Fadd-on%2Fdefinitions%2Fidentity)}",
|
|
1467
|
-
"method": "
|
|
1468
|
-
"rel": "
|
|
1469
|
-
"
|
|
1470
|
-
"
|
|
1530
|
+
"description": "Change add-on plan. Some add-ons may not support changing plans. In that case, an error will be returned.",
|
|
1531
|
+
"href": "/apps/{(%23%2Fdefinitions%2Fapp%2Fdefinitions%2Fidentity)}/addons/{(%23%2Fdefinitions%2Fadd-on%2Fdefinitions%2Fidentity)}",
|
|
1532
|
+
"method": "PATCH",
|
|
1533
|
+
"rel": "update",
|
|
1534
|
+
"schema": {
|
|
1535
|
+
"properties": {
|
|
1536
|
+
"plan": {
|
|
1537
|
+
"$ref": "#/definitions/plan/definitions/identity"
|
|
1538
|
+
}
|
|
1539
|
+
},
|
|
1540
|
+
"required": [
|
|
1541
|
+
"plan"
|
|
1542
|
+
],
|
|
1543
|
+
"type": [
|
|
1544
|
+
"object"
|
|
1545
|
+
]
|
|
1471
1546
|
},
|
|
1472
|
-
"title": "
|
|
1547
|
+
"title": "Update"
|
|
1473
1548
|
},
|
|
1474
1549
|
{
|
|
1475
1550
|
"description": "List all existing add-ons a user has access to",
|
|
@@ -1484,11 +1559,11 @@
|
|
|
1484
1559
|
"array"
|
|
1485
1560
|
]
|
|
1486
1561
|
},
|
|
1487
|
-
"title": "List
|
|
1562
|
+
"title": "List By User"
|
|
1488
1563
|
},
|
|
1489
1564
|
{
|
|
1490
|
-
"description": "List
|
|
1491
|
-
"href": "/
|
|
1565
|
+
"description": "List add-ons used across all Team apps",
|
|
1566
|
+
"href": "/teams/{(%23%2Fdefinitions%2Fteam%2Fdefinitions%2Fidentity)}/addons",
|
|
1492
1567
|
"method": "GET",
|
|
1493
1568
|
"rel": "instances",
|
|
1494
1569
|
"targetSchema": {
|
|
@@ -1499,27 +1574,7 @@
|
|
|
1499
1574
|
"array"
|
|
1500
1575
|
]
|
|
1501
1576
|
},
|
|
1502
|
-
"title": "List
|
|
1503
|
-
},
|
|
1504
|
-
{
|
|
1505
|
-
"description": "Change add-on plan. Some add-ons may not support changing plans. In that case, an error will be returned.",
|
|
1506
|
-
"href": "/apps/{(%23%2Fdefinitions%2Fapp%2Fdefinitions%2Fidentity)}/addons/{(%23%2Fdefinitions%2Fadd-on%2Fdefinitions%2Fidentity)}",
|
|
1507
|
-
"method": "PATCH",
|
|
1508
|
-
"rel": "update",
|
|
1509
|
-
"schema": {
|
|
1510
|
-
"properties": {
|
|
1511
|
-
"plan": {
|
|
1512
|
-
"$ref": "#/definitions/plan/definitions/identity"
|
|
1513
|
-
}
|
|
1514
|
-
},
|
|
1515
|
-
"required": [
|
|
1516
|
-
"plan"
|
|
1517
|
-
],
|
|
1518
|
-
"type": [
|
|
1519
|
-
"object"
|
|
1520
|
-
]
|
|
1521
|
-
},
|
|
1522
|
-
"title": "Update"
|
|
1577
|
+
"title": "List By Team"
|
|
1523
1578
|
}
|
|
1524
1579
|
],
|
|
1525
1580
|
"properties": {
|
|
@@ -1683,6 +1738,22 @@
|
|
|
1683
1738
|
"type": [
|
|
1684
1739
|
"string"
|
|
1685
1740
|
]
|
|
1741
|
+
},
|
|
1742
|
+
"display_name": {
|
|
1743
|
+
"description": "user readable feature name",
|
|
1744
|
+
"example": "My Feature",
|
|
1745
|
+
"readOnly": true,
|
|
1746
|
+
"type": [
|
|
1747
|
+
"string"
|
|
1748
|
+
]
|
|
1749
|
+
},
|
|
1750
|
+
"feedback_email": {
|
|
1751
|
+
"description": "e-mail to send feedback about the feature",
|
|
1752
|
+
"example": "feedback@heroku.com",
|
|
1753
|
+
"readOnly": true,
|
|
1754
|
+
"type": [
|
|
1755
|
+
"string"
|
|
1756
|
+
]
|
|
1686
1757
|
}
|
|
1687
1758
|
},
|
|
1688
1759
|
"links": [
|
|
@@ -1759,6 +1830,12 @@
|
|
|
1759
1830
|
},
|
|
1760
1831
|
"updated_at": {
|
|
1761
1832
|
"$ref": "#/definitions/app-feature/definitions/updated_at"
|
|
1833
|
+
},
|
|
1834
|
+
"display_name": {
|
|
1835
|
+
"$ref": "#/definitions/app-feature/definitions/display_name"
|
|
1836
|
+
},
|
|
1837
|
+
"feedback_email": {
|
|
1838
|
+
"$ref": "#/definitions/app-feature/definitions/feedback_email"
|
|
1762
1839
|
}
|
|
1763
1840
|
}
|
|
1764
1841
|
},
|
|
@@ -2594,7 +2671,7 @@
|
|
|
2594
2671
|
"title": "List"
|
|
2595
2672
|
},
|
|
2596
2673
|
{
|
|
2597
|
-
"description": "List owned and collaborated apps (excludes
|
|
2674
|
+
"description": "List owned and collaborated apps (excludes team apps).",
|
|
2598
2675
|
"href": "/users/{(%23%2Fdefinitions%2Faccount%2Fdefinitions%2Fidentity)}/apps",
|
|
2599
2676
|
"method": "GET",
|
|
2600
2677
|
"ranges": [
|
|
@@ -2707,6 +2784,21 @@
|
|
|
2707
2784
|
"object"
|
|
2708
2785
|
]
|
|
2709
2786
|
},
|
|
2787
|
+
"team": {
|
|
2788
|
+
"description": "identity of team",
|
|
2789
|
+
"properties": {
|
|
2790
|
+
"id": {
|
|
2791
|
+
"$ref": "#/definitions/team/definitions/id"
|
|
2792
|
+
},
|
|
2793
|
+
"name": {
|
|
2794
|
+
"$ref": "#/definitions/team/definitions/name"
|
|
2795
|
+
}
|
|
2796
|
+
},
|
|
2797
|
+
"type": [
|
|
2798
|
+
"null",
|
|
2799
|
+
"object"
|
|
2800
|
+
]
|
|
2801
|
+
},
|
|
2710
2802
|
"region": {
|
|
2711
2803
|
"description": "identity of app region",
|
|
2712
2804
|
"properties": {
|
|
@@ -3440,11 +3532,11 @@
|
|
|
3440
3532
|
"array"
|
|
3441
3533
|
],
|
|
3442
3534
|
"items": {
|
|
3443
|
-
"$ref": "#/definitions/
|
|
3535
|
+
"$ref": "#/definitions/team-app-permission"
|
|
3444
3536
|
}
|
|
3445
3537
|
},
|
|
3446
3538
|
"role": {
|
|
3447
|
-
"$ref": "#/definitions/
|
|
3539
|
+
"$ref": "#/definitions/team/definitions/role"
|
|
3448
3540
|
},
|
|
3449
3541
|
"updated_at": {
|
|
3450
3542
|
"$ref": "#/definitions/collaborator/definitions/updated_at"
|
|
@@ -4452,6 +4544,9 @@
|
|
|
4452
4544
|
},
|
|
4453
4545
|
{
|
|
4454
4546
|
"$ref": "#/definitions/space"
|
|
4547
|
+
},
|
|
4548
|
+
{
|
|
4549
|
+
"$ref": "#/definitions/team"
|
|
4455
4550
|
}
|
|
4456
4551
|
],
|
|
4457
4552
|
"readOnly": true,
|
|
@@ -4504,6 +4599,7 @@
|
|
|
4504
4599
|
"organization",
|
|
4505
4600
|
"release",
|
|
4506
4601
|
"space",
|
|
4602
|
+
"team",
|
|
4507
4603
|
"user"
|
|
4508
4604
|
],
|
|
4509
4605
|
"example": "app",
|
|
@@ -4779,7 +4875,7 @@
|
|
|
4779
4875
|
},
|
|
4780
4876
|
"targetSchema": {
|
|
4781
4877
|
"items": {
|
|
4782
|
-
"$ref": "#/definitions/
|
|
4878
|
+
"$ref": "#/definitions/team-app"
|
|
4783
4879
|
},
|
|
4784
4880
|
"type": [
|
|
4785
4881
|
"array"
|
|
@@ -4949,7 +5045,7 @@
|
|
|
4949
5045
|
"array"
|
|
4950
5046
|
]
|
|
4951
5047
|
},
|
|
4952
|
-
"title": "Batch
|
|
5048
|
+
"title": "Batch Update"
|
|
4953
5049
|
},
|
|
4954
5050
|
{
|
|
4955
5051
|
"description": "Update process type",
|
|
@@ -5100,7 +5196,7 @@
|
|
|
5100
5196
|
"array"
|
|
5101
5197
|
]
|
|
5102
5198
|
},
|
|
5103
|
-
"title": "List"
|
|
5199
|
+
"title": "List By Organization"
|
|
5104
5200
|
},
|
|
5105
5201
|
{
|
|
5106
5202
|
"description": "Create an Identity Provider for an organization",
|
|
@@ -5134,7 +5230,7 @@
|
|
|
5134
5230
|
"targetSchema": {
|
|
5135
5231
|
"$ref": "#/definitions/identity-provider"
|
|
5136
5232
|
},
|
|
5137
|
-
"title": "Create"
|
|
5233
|
+
"title": "Create By Organization"
|
|
5138
5234
|
},
|
|
5139
5235
|
{
|
|
5140
5236
|
"description": "Update an organization's Identity Provider",
|
|
@@ -5163,7 +5259,7 @@
|
|
|
5163
5259
|
"targetSchema": {
|
|
5164
5260
|
"$ref": "#/definitions/identity-provider"
|
|
5165
5261
|
},
|
|
5166
|
-
"title": "Update"
|
|
5262
|
+
"title": "Update By Organization"
|
|
5167
5263
|
},
|
|
5168
5264
|
{
|
|
5169
5265
|
"description": "Delete an organization's Identity Provider",
|
|
@@ -5173,7 +5269,95 @@
|
|
|
5173
5269
|
"targetSchema": {
|
|
5174
5270
|
"$ref": "#/definitions/identity-provider"
|
|
5175
5271
|
},
|
|
5176
|
-
"title": "Delete"
|
|
5272
|
+
"title": "Delete By Organization"
|
|
5273
|
+
},
|
|
5274
|
+
{
|
|
5275
|
+
"description": "Get a list of a team's Identity Providers",
|
|
5276
|
+
"href": "/teams/{(%23%2Fdefinitions%2Fteam%2Fdefinitions%2Fidentity)}/identity-providers",
|
|
5277
|
+
"method": "GET",
|
|
5278
|
+
"rel": "instances",
|
|
5279
|
+
"targetSchema": {
|
|
5280
|
+
"items": {
|
|
5281
|
+
"$ref": "#/definitions/identity-provider"
|
|
5282
|
+
},
|
|
5283
|
+
"type": [
|
|
5284
|
+
"array"
|
|
5285
|
+
]
|
|
5286
|
+
},
|
|
5287
|
+
"title": "List By Team"
|
|
5288
|
+
},
|
|
5289
|
+
{
|
|
5290
|
+
"description": "Create an Identity Provider for a team",
|
|
5291
|
+
"href": "/teams/{(%23%2Fdefinitions%2Fteam%2Fdefinitions%2Fidentity)}/identity-providers",
|
|
5292
|
+
"method": "POST",
|
|
5293
|
+
"rel": "create",
|
|
5294
|
+
"schema": {
|
|
5295
|
+
"properties": {
|
|
5296
|
+
"certificate": {
|
|
5297
|
+
"$ref": "#/definitions/identity-provider/definitions/certificate"
|
|
5298
|
+
},
|
|
5299
|
+
"entity_id": {
|
|
5300
|
+
"$ref": "#/definitions/identity-provider/definitions/entity_id"
|
|
5301
|
+
},
|
|
5302
|
+
"slo_target_url": {
|
|
5303
|
+
"$ref": "#/definitions/identity-provider/definitions/slo_target_url"
|
|
5304
|
+
},
|
|
5305
|
+
"sso_target_url": {
|
|
5306
|
+
"$ref": "#/definitions/identity-provider/definitions/sso_target_url"
|
|
5307
|
+
}
|
|
5308
|
+
},
|
|
5309
|
+
"required": [
|
|
5310
|
+
"certificate",
|
|
5311
|
+
"sso_target_url",
|
|
5312
|
+
"entity_id"
|
|
5313
|
+
],
|
|
5314
|
+
"type": [
|
|
5315
|
+
"object"
|
|
5316
|
+
]
|
|
5317
|
+
},
|
|
5318
|
+
"targetSchema": {
|
|
5319
|
+
"$ref": "#/definitions/identity-provider"
|
|
5320
|
+
},
|
|
5321
|
+
"title": "Create By Team"
|
|
5322
|
+
},
|
|
5323
|
+
{
|
|
5324
|
+
"description": "Update a team's Identity Provider",
|
|
5325
|
+
"href": "/teams/{(%23%2Fdefinitions%2Fteam%2Fdefinitions%2Fidentity)}/identity-providers/{(%23%2Fdefinitions%2Fidentity-provider%2Fdefinitions%2Fid)}",
|
|
5326
|
+
"method": "PATCH",
|
|
5327
|
+
"rel": "update",
|
|
5328
|
+
"schema": {
|
|
5329
|
+
"properties": {
|
|
5330
|
+
"certificate": {
|
|
5331
|
+
"$ref": "#/definitions/identity-provider/definitions/certificate"
|
|
5332
|
+
},
|
|
5333
|
+
"entity_id": {
|
|
5334
|
+
"$ref": "#/definitions/identity-provider/definitions/entity_id"
|
|
5335
|
+
},
|
|
5336
|
+
"slo_target_url": {
|
|
5337
|
+
"$ref": "#/definitions/identity-provider/definitions/slo_target_url"
|
|
5338
|
+
},
|
|
5339
|
+
"sso_target_url": {
|
|
5340
|
+
"$ref": "#/definitions/identity-provider/definitions/sso_target_url"
|
|
5341
|
+
}
|
|
5342
|
+
},
|
|
5343
|
+
"type": [
|
|
5344
|
+
"object"
|
|
5345
|
+
]
|
|
5346
|
+
},
|
|
5347
|
+
"targetSchema": {
|
|
5348
|
+
"$ref": "#/definitions/identity-provider"
|
|
5349
|
+
},
|
|
5350
|
+
"title": "Update By Team"
|
|
5351
|
+
},
|
|
5352
|
+
{
|
|
5353
|
+
"description": "Delete a team's Identity Provider",
|
|
5354
|
+
"href": "/teams/{(%23%2Fdefinitions%2Fteam%2Fdefinitions%2Fname)}/identity-providers/{(%23%2Fdefinitions%2Fidentity-provider%2Fdefinitions%2Fid)}",
|
|
5355
|
+
"method": "DELETE",
|
|
5356
|
+
"rel": "destroy",
|
|
5357
|
+
"targetSchema": {
|
|
5358
|
+
"$ref": "#/definitions/identity-provider"
|
|
5359
|
+
},
|
|
5360
|
+
"title": "Delete By Team"
|
|
5177
5361
|
}
|
|
5178
5362
|
],
|
|
5179
5363
|
"properties": {
|
|
@@ -5296,7 +5480,7 @@
|
|
|
5296
5480
|
"targetSchema": {
|
|
5297
5481
|
"$ref": "#/definitions/inbound-ruleset"
|
|
5298
5482
|
},
|
|
5299
|
-
"title": "
|
|
5483
|
+
"title": "Current"
|
|
5300
5484
|
},
|
|
5301
5485
|
{
|
|
5302
5486
|
"description": "Info on an existing Inbound Ruleset",
|
|
@@ -7077,8 +7261,9 @@
|
|
|
7077
7261
|
},
|
|
7078
7262
|
"organization-add-on": {
|
|
7079
7263
|
"$schema": "http://json-schema.org/draft-04/hyper-schema",
|
|
7080
|
-
"description": "A list of add-ons the Organization uses across all apps",
|
|
7264
|
+
"description": "Deprecated: A list of add-ons the Organization uses across all apps",
|
|
7081
7265
|
"stability": "production",
|
|
7266
|
+
"deprecated_at": "2017-04-10",
|
|
7082
7267
|
"title": "Heroku Platform API - Organization Add-on",
|
|
7083
7268
|
"type": [
|
|
7084
7269
|
"object"
|
|
@@ -7102,9 +7287,10 @@
|
|
|
7102
7287
|
]
|
|
7103
7288
|
},
|
|
7104
7289
|
"organization-app-collaborator": {
|
|
7105
|
-
"description": "An organization collaborator represents an account that has been given access to an organization app on Heroku.",
|
|
7290
|
+
"description": "Deprecated: An organization collaborator represents an account that has been given access to an organization app on Heroku.",
|
|
7106
7291
|
"$schema": "http://json-schema.org/draft-04/hyper-schema",
|
|
7107
7292
|
"stability": "prototype",
|
|
7293
|
+
"deprecated_at": "2017-04-10",
|
|
7108
7294
|
"title": "Heroku Platform API - Organization App Collaborator",
|
|
7109
7295
|
"type": [
|
|
7110
7296
|
"object"
|
|
@@ -7126,6 +7312,15 @@
|
|
|
7126
7312
|
"rel": "create",
|
|
7127
7313
|
"schema": {
|
|
7128
7314
|
"properties": {
|
|
7315
|
+
"permissions": {
|
|
7316
|
+
"type": [
|
|
7317
|
+
"array"
|
|
7318
|
+
],
|
|
7319
|
+
"items": {
|
|
7320
|
+
"$ref": "#/definitions/organization-app-permission/definitions/name"
|
|
7321
|
+
},
|
|
7322
|
+
"description": "An array of permissions to give to the collaborator."
|
|
7323
|
+
},
|
|
7129
7324
|
"silent": {
|
|
7130
7325
|
"$ref": "#/definitions/collaborator/definitions/silent"
|
|
7131
7326
|
},
|
|
@@ -7170,6 +7365,25 @@
|
|
|
7170
7365
|
"href": "/organizations/apps/{(%23%2Fdefinitions%2Forganization-app%2Fdefinitions%2Fidentity)}/collaborators/{(%23%2Fdefinitions%2Forganization-app-collaborator%2Fdefinitions%2Fidentity)}",
|
|
7171
7366
|
"method": "PATCH",
|
|
7172
7367
|
"rel": "update",
|
|
7368
|
+
"schema": {
|
|
7369
|
+
"properties": {
|
|
7370
|
+
"permissions": {
|
|
7371
|
+
"type": [
|
|
7372
|
+
"array"
|
|
7373
|
+
],
|
|
7374
|
+
"items": {
|
|
7375
|
+
"$ref": "#/definitions/organization-app-permission/definitions/name"
|
|
7376
|
+
},
|
|
7377
|
+
"description": "An array of permissions to give to the collaborator."
|
|
7378
|
+
}
|
|
7379
|
+
},
|
|
7380
|
+
"required": [
|
|
7381
|
+
"permissions"
|
|
7382
|
+
],
|
|
7383
|
+
"type": [
|
|
7384
|
+
"object"
|
|
7385
|
+
]
|
|
7386
|
+
},
|
|
7173
7387
|
"targetSchema": {
|
|
7174
7388
|
"$ref": "#/definitions/organization-app-collaborator"
|
|
7175
7389
|
},
|
|
@@ -7241,8 +7455,9 @@
|
|
|
7241
7455
|
},
|
|
7242
7456
|
"organization-app": {
|
|
7243
7457
|
"$schema": "http://json-schema.org/draft-04/hyper-schema",
|
|
7244
|
-
"description": "An organization app encapsulates the organization specific functionality of Heroku apps.",
|
|
7458
|
+
"description": "Deprecated: An organization app encapsulates the organization specific functionality of Heroku apps.",
|
|
7245
7459
|
"stability": "prototype",
|
|
7460
|
+
"deprecated_at": "2017-04-10",
|
|
7246
7461
|
"title": "Heroku Platform API - Organization App",
|
|
7247
7462
|
"type": [
|
|
7248
7463
|
"object"
|
|
@@ -7536,9 +7751,10 @@
|
|
|
7536
7751
|
}
|
|
7537
7752
|
},
|
|
7538
7753
|
"organization-feature": {
|
|
7539
|
-
"description": "An organization feature represents a feature enabled on an organization account.",
|
|
7754
|
+
"description": "Deprecated: An organization feature represents a feature enabled on an organization account.",
|
|
7540
7755
|
"$schema": "http://json-schema.org/draft-04/hyper-schema",
|
|
7541
7756
|
"stability": "prototype",
|
|
7757
|
+
"deprecated_at": "2017-04-10",
|
|
7542
7758
|
"strictProperties": true,
|
|
7543
7759
|
"title": "Heroku Platform API - Organization Feature",
|
|
7544
7760
|
"type": [
|
|
@@ -7571,7 +7787,7 @@
|
|
|
7571
7787
|
]
|
|
7572
7788
|
},
|
|
7573
7789
|
"enabled": {
|
|
7574
|
-
"description": "whether or not
|
|
7790
|
+
"description": "whether or not organization feature has been enabled",
|
|
7575
7791
|
"example": true,
|
|
7576
7792
|
"readOnly": false,
|
|
7577
7793
|
"type": [
|
|
@@ -7621,11 +7837,27 @@
|
|
|
7621
7837
|
"type": [
|
|
7622
7838
|
"string"
|
|
7623
7839
|
]
|
|
7840
|
+
},
|
|
7841
|
+
"display_name": {
|
|
7842
|
+
"description": "user readable feature name",
|
|
7843
|
+
"example": "My Feature",
|
|
7844
|
+
"readOnly": true,
|
|
7845
|
+
"type": [
|
|
7846
|
+
"string"
|
|
7847
|
+
]
|
|
7848
|
+
},
|
|
7849
|
+
"feedback_email": {
|
|
7850
|
+
"description": "e-mail to send feedback about the feature",
|
|
7851
|
+
"example": "feedback@heroku.com",
|
|
7852
|
+
"readOnly": true,
|
|
7853
|
+
"type": [
|
|
7854
|
+
"string"
|
|
7855
|
+
]
|
|
7624
7856
|
}
|
|
7625
7857
|
},
|
|
7626
7858
|
"links": [
|
|
7627
7859
|
{
|
|
7628
|
-
"description": "Info for an existing
|
|
7860
|
+
"description": "Info for an existing organization feature.",
|
|
7629
7861
|
"href": "/organizations/{(%23%2Fdefinitions%2Forganization%2Fdefinitions%2Fidentity)}/features/{(%23%2Fdefinitions%2Forganization-feature%2Fdefinitions%2Fidentity)}",
|
|
7630
7862
|
"method": "GET",
|
|
7631
7863
|
"rel": "self",
|
|
@@ -7648,39 +7880,69 @@
|
|
|
7648
7880
|
]
|
|
7649
7881
|
},
|
|
7650
7882
|
"title": "List"
|
|
7651
|
-
}
|
|
7652
|
-
|
|
7653
|
-
|
|
7654
|
-
|
|
7655
|
-
"
|
|
7656
|
-
|
|
7657
|
-
|
|
7658
|
-
|
|
7883
|
+
},
|
|
7884
|
+
{
|
|
7885
|
+
"description": "Update an existing organization feature.",
|
|
7886
|
+
"href": "/organizations/{(%23%2Fdefinitions%2Forganization%2Fdefinitions%2Fidentity)}/features/{(%23%2Fdefinitions%2Forganization-feature%2Fdefinitions%2Fidentity)}",
|
|
7887
|
+
"method": "PATCH",
|
|
7888
|
+
"rel": "update",
|
|
7889
|
+
"schema": {
|
|
7890
|
+
"properties": {
|
|
7891
|
+
"enabled": {
|
|
7892
|
+
"$ref": "#/definitions/organization-feature/definitions/enabled"
|
|
7893
|
+
}
|
|
7894
|
+
},
|
|
7895
|
+
"required": [
|
|
7896
|
+
"enabled"
|
|
7897
|
+
],
|
|
7898
|
+
"type": [
|
|
7899
|
+
"object"
|
|
7900
|
+
]
|
|
7901
|
+
},
|
|
7902
|
+
"targetSchema": {
|
|
7903
|
+
"$ref": "#/definitions/organization-feature"
|
|
7904
|
+
},
|
|
7905
|
+
"title": "Update"
|
|
7906
|
+
}
|
|
7907
|
+
],
|
|
7908
|
+
"properties": {
|
|
7909
|
+
"created_at": {
|
|
7910
|
+
"$ref": "#/definitions/organization-feature/definitions/created_at"
|
|
7911
|
+
},
|
|
7912
|
+
"description": {
|
|
7913
|
+
"$ref": "#/definitions/organization-feature/definitions/description"
|
|
7659
7914
|
},
|
|
7660
7915
|
"doc_url": {
|
|
7661
|
-
"$ref": "#/definitions/
|
|
7916
|
+
"$ref": "#/definitions/organization-feature/definitions/doc_url"
|
|
7662
7917
|
},
|
|
7663
7918
|
"enabled": {
|
|
7664
|
-
"$ref": "#/definitions/
|
|
7919
|
+
"$ref": "#/definitions/organization-feature/definitions/enabled"
|
|
7665
7920
|
},
|
|
7666
7921
|
"id": {
|
|
7667
|
-
"$ref": "#/definitions/
|
|
7922
|
+
"$ref": "#/definitions/organization-feature/definitions/id"
|
|
7668
7923
|
},
|
|
7669
7924
|
"name": {
|
|
7670
|
-
"$ref": "#/definitions/
|
|
7925
|
+
"$ref": "#/definitions/organization-feature/definitions/name"
|
|
7671
7926
|
},
|
|
7672
7927
|
"state": {
|
|
7673
|
-
"$ref": "#/definitions/
|
|
7928
|
+
"$ref": "#/definitions/organization-feature/definitions/state"
|
|
7674
7929
|
},
|
|
7675
7930
|
"updated_at": {
|
|
7676
|
-
"$ref": "#/definitions/
|
|
7931
|
+
"$ref": "#/definitions/organization-feature/definitions/updated_at"
|
|
7932
|
+
},
|
|
7933
|
+
"display_name": {
|
|
7934
|
+
"$ref": "#/definitions/organization-feature/definitions/display_name"
|
|
7935
|
+
},
|
|
7936
|
+
"feedback_email": {
|
|
7937
|
+
"$ref": "#/definitions/organization-feature/definitions/feedback_email"
|
|
7677
7938
|
}
|
|
7678
7939
|
}
|
|
7679
7940
|
},
|
|
7680
7941
|
"organization-invitation": {
|
|
7681
|
-
"description": "An organization invitation represents an invite to an organization.",
|
|
7942
|
+
"description": "Deprecated: An organization invitation represents an invite to an organization.",
|
|
7682
7943
|
"$schema": "http://json-schema.org/draft-04/hyper-schema",
|
|
7683
7944
|
"stability": "prototype",
|
|
7945
|
+
"deprecated_at": "2017-04-10",
|
|
7684
7946
|
"strictProperties": true,
|
|
7685
7947
|
"title": "Heroku Platform API - Organization Invitation",
|
|
7686
7948
|
"type": [
|
|
@@ -7863,8 +8125,9 @@
|
|
|
7863
8125
|
},
|
|
7864
8126
|
"organization-invoice": {
|
|
7865
8127
|
"$schema": "http://json-schema.org/draft-04/hyper-schema",
|
|
7866
|
-
"description": "An organization invoice is an itemized bill of goods for an organization which includes pricing and charges.",
|
|
8128
|
+
"description": "Deprecated: An organization invoice is an itemized bill of goods for an organization which includes pricing and charges.",
|
|
7867
8129
|
"stability": "prototype",
|
|
8130
|
+
"deprecated_at": "2017-04-10",
|
|
7868
8131
|
"strictProperties": true,
|
|
7869
8132
|
"title": "Heroku Platform API - Organization Invoice",
|
|
7870
8133
|
"type": [
|
|
@@ -8090,8 +8353,9 @@
|
|
|
8090
8353
|
},
|
|
8091
8354
|
"organization-member": {
|
|
8092
8355
|
"$schema": "http://json-schema.org/draft-04/hyper-schema",
|
|
8093
|
-
"description": "An organization member is an individual with access to an organization.",
|
|
8356
|
+
"description": "Deprecated: An organization member is an individual with access to an organization.",
|
|
8094
8357
|
"stability": "prototype",
|
|
8358
|
+
"deprecated_at": "2017-04-10",
|
|
8095
8359
|
"additionalProperties": false,
|
|
8096
8360
|
"required": [
|
|
8097
8361
|
"created_at",
|
|
@@ -8307,7 +8571,7 @@
|
|
|
8307
8571
|
"array"
|
|
8308
8572
|
]
|
|
8309
8573
|
},
|
|
8310
|
-
"title": "List"
|
|
8574
|
+
"title": "App List"
|
|
8311
8575
|
}
|
|
8312
8576
|
],
|
|
8313
8577
|
"properties": {
|
|
@@ -8353,9 +8617,10 @@
|
|
|
8353
8617
|
}
|
|
8354
8618
|
},
|
|
8355
8619
|
"organization-preferences": {
|
|
8356
|
-
"description": "Tracks an organization's preferences",
|
|
8620
|
+
"description": "Deprecated: Tracks an organization's preferences",
|
|
8357
8621
|
"$schema": "http://json-schema.org/draft-04/hyper-schema",
|
|
8358
8622
|
"stability": "prototype",
|
|
8623
|
+
"deprecated_at": "2017-04-10",
|
|
8359
8624
|
"strictProperties": true,
|
|
8360
8625
|
"title": "Heroku Platform API - Organization Preferences",
|
|
8361
8626
|
"type": [
|
|
@@ -8407,6 +8672,9 @@
|
|
|
8407
8672
|
"method": "PATCH",
|
|
8408
8673
|
"rel": "update",
|
|
8409
8674
|
"schema": {
|
|
8675
|
+
"type": [
|
|
8676
|
+
"object"
|
|
8677
|
+
],
|
|
8410
8678
|
"properties": {
|
|
8411
8679
|
"whitelisting-enabled": {
|
|
8412
8680
|
"$ref": "#/definitions/organization-preferences/definitions/whitelisting-enabled"
|
|
@@ -8430,8 +8698,9 @@
|
|
|
8430
8698
|
},
|
|
8431
8699
|
"organization": {
|
|
8432
8700
|
"$schema": "http://json-schema.org/draft-04/hyper-schema",
|
|
8433
|
-
"description": "Organizations allow you to manage access to a shared group of applications across your development team.",
|
|
8701
|
+
"description": "Deprecated: Organizations allow you to manage access to a shared group of applications across your development team.",
|
|
8434
8702
|
"stability": "prototype",
|
|
8703
|
+
"deprecated_at": "2017-04-10",
|
|
8435
8704
|
"strictProperties": true,
|
|
8436
8705
|
"title": "Heroku Platform API - Organization",
|
|
8437
8706
|
"type": [
|
|
@@ -8884,7 +9153,7 @@
|
|
|
8884
9153
|
"targetSchema": {
|
|
8885
9154
|
"$ref": "#/definitions/outbound-ruleset"
|
|
8886
9155
|
},
|
|
8887
|
-
"title": "
|
|
9156
|
+
"title": "Current"
|
|
8888
9157
|
},
|
|
8889
9158
|
{
|
|
8890
9159
|
"description": "Info on an existing Outbound Ruleset",
|
|
@@ -9059,8 +9328,9 @@
|
|
|
9059
9328
|
},
|
|
9060
9329
|
"organization-app-permission": {
|
|
9061
9330
|
"$schema": "http://json-schema.org/draft-04/hyper-schema",
|
|
9062
|
-
"description": "An organization app permission is a behavior that is assigned to a user in an organization app.",
|
|
9331
|
+
"description": "Deprecated: An organization app permission is a behavior that is assigned to a user in an organization app.",
|
|
9063
9332
|
"stability": "prototype",
|
|
9333
|
+
"deprecated_at": "2017-04-10",
|
|
9064
9334
|
"title": "Heroku Platform API - Organization App Permission",
|
|
9065
9335
|
"type": [
|
|
9066
9336
|
"object"
|
|
@@ -9188,7 +9458,7 @@
|
|
|
9188
9458
|
"array"
|
|
9189
9459
|
]
|
|
9190
9460
|
},
|
|
9191
|
-
"title": "List"
|
|
9461
|
+
"title": "List By Pipeline"
|
|
9192
9462
|
},
|
|
9193
9463
|
{
|
|
9194
9464
|
"description": "List pipeline couplings.",
|
|
@@ -9277,14 +9547,14 @@
|
|
|
9277
9547
|
"title": "Update"
|
|
9278
9548
|
},
|
|
9279
9549
|
{
|
|
9280
|
-
"description": "Info for an existing pipeline coupling.",
|
|
9550
|
+
"description": "Info for an existing app pipeline coupling.",
|
|
9281
9551
|
"href": "/apps/{(%23%2Fdefinitions%2Fapp%2Fdefinitions%2Fidentity)}/pipeline-couplings",
|
|
9282
9552
|
"method": "GET",
|
|
9283
9553
|
"rel": "self",
|
|
9284
9554
|
"targetSchema": {
|
|
9285
9555
|
"$ref": "#/definitions/pipeline-coupling"
|
|
9286
9556
|
},
|
|
9287
|
-
"title": "Info"
|
|
9557
|
+
"title": "Info By App"
|
|
9288
9558
|
}
|
|
9289
9559
|
],
|
|
9290
9560
|
"properties": {
|
|
@@ -9517,6 +9787,9 @@
|
|
|
9517
9787
|
},
|
|
9518
9788
|
"source": {
|
|
9519
9789
|
"description": "the app being promoted from",
|
|
9790
|
+
"type": [
|
|
9791
|
+
"object"
|
|
9792
|
+
],
|
|
9520
9793
|
"properties": {
|
|
9521
9794
|
"app": {
|
|
9522
9795
|
"description": "the app which was promoted from",
|
|
@@ -9533,7 +9806,13 @@
|
|
|
9533
9806
|
}
|
|
9534
9807
|
},
|
|
9535
9808
|
"targets": {
|
|
9809
|
+
"type": [
|
|
9810
|
+
"array"
|
|
9811
|
+
],
|
|
9536
9812
|
"items": {
|
|
9813
|
+
"type": [
|
|
9814
|
+
"object"
|
|
9815
|
+
],
|
|
9537
9816
|
"properties": {
|
|
9538
9817
|
"app": {
|
|
9539
9818
|
"description": "the app is being promoted to",
|
|
@@ -9759,13 +10038,13 @@
|
|
|
9759
10038
|
"method": "GET",
|
|
9760
10039
|
"rel": "instances",
|
|
9761
10040
|
"targetSchema": {
|
|
10041
|
+
"type": [
|
|
10042
|
+
"array"
|
|
10043
|
+
],
|
|
9762
10044
|
"items": {
|
|
9763
10045
|
"$ref": "#/definitions/pipeline"
|
|
9764
10046
|
}
|
|
9765
10047
|
},
|
|
9766
|
-
"type": [
|
|
9767
|
-
"array"
|
|
9768
|
-
],
|
|
9769
10048
|
"title": "List"
|
|
9770
10049
|
}
|
|
9771
10050
|
],
|
|
@@ -9949,7 +10228,7 @@
|
|
|
9949
10228
|
"links": [
|
|
9950
10229
|
{
|
|
9951
10230
|
"description": "Info for existing plan.",
|
|
9952
|
-
"href": "/
|
|
10231
|
+
"href": "/plans/{(%23%2Fdefinitions%2Fplan%2Fdefinitions%2Fidentity)}",
|
|
9953
10232
|
"method": "GET",
|
|
9954
10233
|
"rel": "self",
|
|
9955
10234
|
"targetSchema": {
|
|
@@ -9958,7 +10237,17 @@
|
|
|
9958
10237
|
"title": "Info"
|
|
9959
10238
|
},
|
|
9960
10239
|
{
|
|
9961
|
-
"description": "
|
|
10240
|
+
"description": "Info for existing plan by Add-on.",
|
|
10241
|
+
"href": "/addon-services/{(%23%2Fdefinitions%2Fadd-on-service%2Fdefinitions%2Fidentity)}/plans/{(%23%2Fdefinitions%2Fplan%2Fdefinitions%2Fidentity)}",
|
|
10242
|
+
"method": "GET",
|
|
10243
|
+
"rel": "self",
|
|
10244
|
+
"targetSchema": {
|
|
10245
|
+
"$ref": "#/definitions/plan"
|
|
10246
|
+
},
|
|
10247
|
+
"title": "Info By Add-on"
|
|
10248
|
+
},
|
|
10249
|
+
{
|
|
10250
|
+
"description": "List existing plans by Add-on.",
|
|
9962
10251
|
"href": "/addon-services/{(%23%2Fdefinitions%2Fadd-on-service%2Fdefinitions%2Fidentity)}/plans",
|
|
9963
10252
|
"method": "GET",
|
|
9964
10253
|
"rel": "instances",
|
|
@@ -9970,7 +10259,7 @@
|
|
|
9970
10259
|
"array"
|
|
9971
10260
|
]
|
|
9972
10261
|
},
|
|
9973
|
-
"title": "List"
|
|
10262
|
+
"title": "List By Add-on"
|
|
9974
10263
|
}
|
|
9975
10264
|
],
|
|
9976
10265
|
"properties": {
|
|
@@ -11102,6 +11391,9 @@
|
|
|
11102
11391
|
"method": "PATCH",
|
|
11103
11392
|
"rel": "update",
|
|
11104
11393
|
"schema": {
|
|
11394
|
+
"type": [
|
|
11395
|
+
"object"
|
|
11396
|
+
],
|
|
11105
11397
|
"properties": {
|
|
11106
11398
|
"permissions": {
|
|
11107
11399
|
"type": [
|
|
@@ -11484,6 +11776,20 @@
|
|
|
11484
11776
|
"object"
|
|
11485
11777
|
]
|
|
11486
11778
|
},
|
|
11779
|
+
"team": {
|
|
11780
|
+
"description": "team that owns this space",
|
|
11781
|
+
"properties": {
|
|
11782
|
+
"id": {
|
|
11783
|
+
"$ref": "#/definitions/team/definitions/id"
|
|
11784
|
+
},
|
|
11785
|
+
"name": {
|
|
11786
|
+
"$ref": "#/definitions/team/definitions/name"
|
|
11787
|
+
}
|
|
11788
|
+
},
|
|
11789
|
+
"type": [
|
|
11790
|
+
"object"
|
|
11791
|
+
]
|
|
11792
|
+
},
|
|
11487
11793
|
"region": {
|
|
11488
11794
|
"description": "identity of space region",
|
|
11489
11795
|
"properties": {
|
|
@@ -11850,12 +12156,11 @@
|
|
|
11850
12156
|
}
|
|
11851
12157
|
}
|
|
11852
12158
|
},
|
|
11853
|
-
"
|
|
11854
|
-
"description": "
|
|
12159
|
+
"team-app-collaborator": {
|
|
12160
|
+
"description": "A team collaborator represents an account that has been given access to a team app on Heroku.",
|
|
11855
12161
|
"$schema": "http://json-schema.org/draft-04/hyper-schema",
|
|
11856
|
-
"stability": "
|
|
11857
|
-
"
|
|
11858
|
-
"title": "Heroku Platform API - User Preferences",
|
|
12162
|
+
"stability": "development",
|
|
12163
|
+
"title": "Heroku Platform API - Team App Collaborator",
|
|
11859
12164
|
"type": [
|
|
11860
12165
|
"object"
|
|
11861
12166
|
],
|
|
@@ -11863,152 +12168,1955 @@
|
|
|
11863
12168
|
"identity": {
|
|
11864
12169
|
"anyOf": [
|
|
11865
12170
|
{
|
|
11866
|
-
"$ref": "#/definitions/
|
|
12171
|
+
"$ref": "#/definitions/collaborator/definitions/email"
|
|
11867
12172
|
}
|
|
11868
12173
|
]
|
|
11869
|
-
},
|
|
11870
|
-
"self": {
|
|
11871
|
-
"description": "Implicit reference to currently authorized user",
|
|
11872
|
-
"enum": [
|
|
11873
|
-
"~"
|
|
11874
|
-
],
|
|
11875
|
-
"example": "~",
|
|
11876
|
-
"readOnly": true,
|
|
11877
|
-
"type": [
|
|
11878
|
-
"string"
|
|
11879
|
-
]
|
|
11880
|
-
},
|
|
11881
|
-
"timezone": {
|
|
11882
|
-
"description": "User's default timezone",
|
|
11883
|
-
"example": "UTC",
|
|
11884
|
-
"readOnly": false,
|
|
11885
|
-
"type": [
|
|
11886
|
-
"string",
|
|
11887
|
-
"null"
|
|
11888
|
-
]
|
|
11889
|
-
},
|
|
11890
|
-
"default-organization": {
|
|
11891
|
-
"description": "User's default organization",
|
|
11892
|
-
"example": "sushi-inc",
|
|
11893
|
-
"readOnly": false,
|
|
11894
|
-
"type": [
|
|
11895
|
-
"string",
|
|
11896
|
-
"null"
|
|
11897
|
-
]
|
|
11898
|
-
},
|
|
11899
|
-
"dismissed-github-banner": {
|
|
11900
|
-
"description": "Whether the user has dismissed the GitHub link banner",
|
|
11901
|
-
"example": true,
|
|
11902
|
-
"readOnly": false,
|
|
11903
|
-
"type": [
|
|
11904
|
-
"boolean",
|
|
11905
|
-
"null"
|
|
11906
|
-
]
|
|
11907
|
-
},
|
|
11908
|
-
"dismissed-getting-started": {
|
|
11909
|
-
"description": "Whether the user has dismissed the getting started banner",
|
|
11910
|
-
"example": true,
|
|
11911
|
-
"readOnly": false,
|
|
11912
|
-
"type": [
|
|
11913
|
-
"boolean",
|
|
11914
|
-
"null"
|
|
11915
|
-
]
|
|
11916
|
-
},
|
|
11917
|
-
"dismissed-org-access-controls": {
|
|
11918
|
-
"description": "Whether the user has dismissed the Organization Access Controls banner",
|
|
11919
|
-
"example": true,
|
|
11920
|
-
"readOnly": false,
|
|
11921
|
-
"type": [
|
|
11922
|
-
"boolean",
|
|
11923
|
-
"null"
|
|
11924
|
-
]
|
|
11925
|
-
},
|
|
11926
|
-
"dismissed-org-wizard-notification": {
|
|
11927
|
-
"description": "Whether the user has dismissed the Organization Wizard",
|
|
11928
|
-
"example": true,
|
|
11929
|
-
"readOnly": false,
|
|
11930
|
-
"type": [
|
|
11931
|
-
"boolean",
|
|
11932
|
-
"null"
|
|
11933
|
-
]
|
|
11934
|
-
},
|
|
11935
|
-
"dismissed-pipelines-banner": {
|
|
11936
|
-
"description": "Whether the user has dismissed the Pipelines banner",
|
|
11937
|
-
"example": true,
|
|
11938
|
-
"readOnly": false,
|
|
11939
|
-
"type": [
|
|
11940
|
-
"boolean",
|
|
11941
|
-
"null"
|
|
11942
|
-
]
|
|
11943
|
-
},
|
|
11944
|
-
"dismissed-pipelines-github-banner": {
|
|
11945
|
-
"description": "Whether the user has dismissed the GitHub banner on a pipeline overview",
|
|
11946
|
-
"example": true,
|
|
11947
|
-
"readOnly": false,
|
|
11948
|
-
"type": [
|
|
11949
|
-
"boolean",
|
|
11950
|
-
"null"
|
|
11951
|
-
]
|
|
11952
|
-
},
|
|
11953
|
-
"dismissed-pipelines-github-banners": {
|
|
11954
|
-
"description": "Which pipeline uuids the user has dismissed the GitHub banner for",
|
|
11955
|
-
"example": [
|
|
11956
|
-
"96c68759-f310-4910-9867-e0b062064098"
|
|
11957
|
-
],
|
|
11958
|
-
"readOnly": false,
|
|
11959
|
-
"type": [
|
|
11960
|
-
"null",
|
|
11961
|
-
"array"
|
|
11962
|
-
],
|
|
11963
|
-
"items": {
|
|
11964
|
-
"$ref": "#/definitions/pipeline/definitions/id"
|
|
11965
|
-
}
|
|
11966
|
-
},
|
|
11967
|
-
"dismissed-sms-banner": {
|
|
11968
|
-
"description": "Whether the user has dismissed the 2FA SMS banner",
|
|
11969
|
-
"example": true,
|
|
11970
|
-
"readOnly": false,
|
|
11971
|
-
"type": [
|
|
11972
|
-
"boolean",
|
|
11973
|
-
"null"
|
|
11974
|
-
]
|
|
11975
12174
|
}
|
|
11976
12175
|
},
|
|
11977
12176
|
"links": [
|
|
11978
12177
|
{
|
|
11979
|
-
"description": "
|
|
11980
|
-
"href": "/
|
|
12178
|
+
"description": "Create a new collaborator on a team app. Use this endpoint instead of the `/apps/{app_id_or_name}/collaborator` endpoint when you want the collaborator to be granted [permissions] (https://devcenter.heroku.com/articles/org-users-access#roles-and-app-permissions) according to their role in the team.",
|
|
12179
|
+
"href": "/teams/apps/{(%23%2Fdefinitions%2Fapp%2Fdefinitions%2Fidentity)}/collaborators",
|
|
12180
|
+
"method": "POST",
|
|
12181
|
+
"rel": "create",
|
|
12182
|
+
"schema": {
|
|
12183
|
+
"properties": {
|
|
12184
|
+
"permissions": {
|
|
12185
|
+
"type": [
|
|
12186
|
+
"array"
|
|
12187
|
+
],
|
|
12188
|
+
"items": {
|
|
12189
|
+
"$ref": "#/definitions/team-app-permission/definitions/name"
|
|
12190
|
+
},
|
|
12191
|
+
"description": "An array of permissions to give to the collaborator."
|
|
12192
|
+
},
|
|
12193
|
+
"silent": {
|
|
12194
|
+
"$ref": "#/definitions/collaborator/definitions/silent"
|
|
12195
|
+
},
|
|
12196
|
+
"user": {
|
|
12197
|
+
"$ref": "#/definitions/account/definitions/identity"
|
|
12198
|
+
}
|
|
12199
|
+
},
|
|
12200
|
+
"required": [
|
|
12201
|
+
"user"
|
|
12202
|
+
],
|
|
12203
|
+
"type": [
|
|
12204
|
+
"object"
|
|
12205
|
+
]
|
|
12206
|
+
},
|
|
12207
|
+
"targetSchema": {
|
|
12208
|
+
"$ref": "#/definitions/team-app-collaborator"
|
|
12209
|
+
},
|
|
12210
|
+
"title": "Create"
|
|
12211
|
+
},
|
|
12212
|
+
{
|
|
12213
|
+
"description": "Delete an existing collaborator from a team app.",
|
|
12214
|
+
"href": "/teams/apps/{(%23%2Fdefinitions%2Fteam-app%2Fdefinitions%2Fidentity)}/collaborators/{(%23%2Fdefinitions%2Fteam-app-collaborator%2Fdefinitions%2Fidentity)}",
|
|
12215
|
+
"method": "DELETE",
|
|
12216
|
+
"rel": "destroy",
|
|
12217
|
+
"targetSchema": {
|
|
12218
|
+
"$ref": "#/definitions/team-app-collaborator"
|
|
12219
|
+
},
|
|
12220
|
+
"title": "Delete"
|
|
12221
|
+
},
|
|
12222
|
+
{
|
|
12223
|
+
"description": "Info for a collaborator on a team app.",
|
|
12224
|
+
"href": "/teams/apps/{(%23%2Fdefinitions%2Fteam-app%2Fdefinitions%2Fidentity)}/collaborators/{(%23%2Fdefinitions%2Fteam-app-collaborator%2Fdefinitions%2Fidentity)}",
|
|
11981
12225
|
"method": "GET",
|
|
11982
12226
|
"rel": "self",
|
|
11983
12227
|
"targetSchema": {
|
|
11984
|
-
"$ref": "#/definitions/
|
|
12228
|
+
"$ref": "#/definitions/team-app-collaborator"
|
|
11985
12229
|
},
|
|
11986
|
-
"title": "
|
|
12230
|
+
"title": "Info"
|
|
11987
12231
|
},
|
|
11988
12232
|
{
|
|
11989
|
-
"description": "Update
|
|
11990
|
-
"href": "/
|
|
12233
|
+
"description": "Update an existing collaborator from a team app.",
|
|
12234
|
+
"href": "/teams/apps/{(%23%2Fdefinitions%2Fteam-app%2Fdefinitions%2Fidentity)}/collaborators/{(%23%2Fdefinitions%2Fteam-app-collaborator%2Fdefinitions%2Fidentity)}",
|
|
11991
12235
|
"method": "PATCH",
|
|
11992
12236
|
"rel": "update",
|
|
11993
12237
|
"schema": {
|
|
11994
12238
|
"properties": {
|
|
11995
|
-
"
|
|
11996
|
-
"
|
|
11997
|
-
|
|
11998
|
-
|
|
11999
|
-
"
|
|
12000
|
-
|
|
12001
|
-
|
|
12002
|
-
"
|
|
12003
|
-
}
|
|
12004
|
-
|
|
12005
|
-
|
|
12006
|
-
|
|
12007
|
-
|
|
12008
|
-
|
|
12009
|
-
|
|
12010
|
-
|
|
12011
|
-
|
|
12239
|
+
"permissions": {
|
|
12240
|
+
"type": [
|
|
12241
|
+
"array"
|
|
12242
|
+
],
|
|
12243
|
+
"items": {
|
|
12244
|
+
"$ref": "#/definitions/team-app-permission/definitions/name"
|
|
12245
|
+
},
|
|
12246
|
+
"description": "An array of permissions to give to the collaborator."
|
|
12247
|
+
}
|
|
12248
|
+
},
|
|
12249
|
+
"required": [
|
|
12250
|
+
"permissions"
|
|
12251
|
+
],
|
|
12252
|
+
"type": [
|
|
12253
|
+
"object"
|
|
12254
|
+
]
|
|
12255
|
+
},
|
|
12256
|
+
"targetSchema": {
|
|
12257
|
+
"$ref": "#/definitions/team-app-collaborator"
|
|
12258
|
+
},
|
|
12259
|
+
"title": "Update"
|
|
12260
|
+
},
|
|
12261
|
+
{
|
|
12262
|
+
"description": "List collaborators on a team app.",
|
|
12263
|
+
"href": "/teams/apps/{(%23%2Fdefinitions%2Fteam-app%2Fdefinitions%2Fidentity)}/collaborators",
|
|
12264
|
+
"method": "GET",
|
|
12265
|
+
"rel": "instances",
|
|
12266
|
+
"targetSchema": {
|
|
12267
|
+
"items": {
|
|
12268
|
+
"$ref": "#/definitions/team-app-collaborator"
|
|
12269
|
+
},
|
|
12270
|
+
"type": [
|
|
12271
|
+
"array"
|
|
12272
|
+
]
|
|
12273
|
+
},
|
|
12274
|
+
"title": "List"
|
|
12275
|
+
}
|
|
12276
|
+
],
|
|
12277
|
+
"properties": {
|
|
12278
|
+
"app": {
|
|
12279
|
+
"description": "app collaborator belongs to",
|
|
12280
|
+
"properties": {
|
|
12281
|
+
"name": {
|
|
12282
|
+
"$ref": "#/definitions/app/definitions/name"
|
|
12283
|
+
},
|
|
12284
|
+
"id": {
|
|
12285
|
+
"$ref": "#/definitions/app/definitions/id"
|
|
12286
|
+
}
|
|
12287
|
+
},
|
|
12288
|
+
"strictProperties": true,
|
|
12289
|
+
"type": [
|
|
12290
|
+
"object"
|
|
12291
|
+
]
|
|
12292
|
+
},
|
|
12293
|
+
"created_at": {
|
|
12294
|
+
"$ref": "#/definitions/collaborator/definitions/created_at"
|
|
12295
|
+
},
|
|
12296
|
+
"id": {
|
|
12297
|
+
"$ref": "#/definitions/collaborator/definitions/id"
|
|
12298
|
+
},
|
|
12299
|
+
"role": {
|
|
12300
|
+
"$ref": "#/definitions/team/definitions/role"
|
|
12301
|
+
},
|
|
12302
|
+
"updated_at": {
|
|
12303
|
+
"$ref": "#/definitions/collaborator/definitions/updated_at"
|
|
12304
|
+
},
|
|
12305
|
+
"user": {
|
|
12306
|
+
"description": "identity of collaborated account",
|
|
12307
|
+
"properties": {
|
|
12308
|
+
"email": {
|
|
12309
|
+
"$ref": "#/definitions/account/definitions/email"
|
|
12310
|
+
},
|
|
12311
|
+
"federated": {
|
|
12312
|
+
"$ref": "#/definitions/account/definitions/federated"
|
|
12313
|
+
},
|
|
12314
|
+
"id": {
|
|
12315
|
+
"$ref": "#/definitions/account/definitions/id"
|
|
12316
|
+
}
|
|
12317
|
+
},
|
|
12318
|
+
"strictProperties": true,
|
|
12319
|
+
"type": [
|
|
12320
|
+
"object"
|
|
12321
|
+
]
|
|
12322
|
+
}
|
|
12323
|
+
}
|
|
12324
|
+
},
|
|
12325
|
+
"team-app-permission": {
|
|
12326
|
+
"$schema": "http://json-schema.org/draft-04/hyper-schema",
|
|
12327
|
+
"description": "A team app permission is a behavior that is assigned to a user in a team app.",
|
|
12328
|
+
"stability": "prototype",
|
|
12329
|
+
"title": "Heroku Platform API - Team App Permission",
|
|
12330
|
+
"type": [
|
|
12331
|
+
"object"
|
|
12332
|
+
],
|
|
12333
|
+
"definitions": {
|
|
12334
|
+
"identity": {
|
|
12335
|
+
"anyOf": [
|
|
12336
|
+
{
|
|
12337
|
+
"$ref": "#/definitions/team-app-permission/definitions/name"
|
|
12338
|
+
}
|
|
12339
|
+
]
|
|
12340
|
+
},
|
|
12341
|
+
"name": {
|
|
12342
|
+
"description": "The name of the app permission.",
|
|
12343
|
+
"example": "view",
|
|
12344
|
+
"readOnly": true,
|
|
12345
|
+
"type": [
|
|
12346
|
+
"string"
|
|
12347
|
+
]
|
|
12348
|
+
},
|
|
12349
|
+
"description": {
|
|
12350
|
+
"description": "A description of what the app permission allows.",
|
|
12351
|
+
"example": "Can manage config, deploy, run commands and restart the app.",
|
|
12352
|
+
"readOnly": true,
|
|
12353
|
+
"type": [
|
|
12354
|
+
"string"
|
|
12355
|
+
]
|
|
12356
|
+
}
|
|
12357
|
+
},
|
|
12358
|
+
"links": [
|
|
12359
|
+
{
|
|
12360
|
+
"description": "Lists permissions available to teams.",
|
|
12361
|
+
"href": "/teams/permissions",
|
|
12362
|
+
"method": "GET",
|
|
12363
|
+
"rel": "instances",
|
|
12364
|
+
"targetSchema": {
|
|
12365
|
+
"items": {
|
|
12366
|
+
"$ref": "#/definitions/team-app-permission"
|
|
12367
|
+
},
|
|
12368
|
+
"type": [
|
|
12369
|
+
"array"
|
|
12370
|
+
]
|
|
12371
|
+
},
|
|
12372
|
+
"title": "List"
|
|
12373
|
+
}
|
|
12374
|
+
],
|
|
12375
|
+
"properties": {
|
|
12376
|
+
"name": {
|
|
12377
|
+
"$ref": "#/definitions/team-app-permission/definitions/name"
|
|
12378
|
+
},
|
|
12379
|
+
"description": {
|
|
12380
|
+
"$ref": "#/definitions/team-app-permission/definitions/description"
|
|
12381
|
+
}
|
|
12382
|
+
}
|
|
12383
|
+
},
|
|
12384
|
+
"team-app": {
|
|
12385
|
+
"$schema": "http://json-schema.org/draft-04/hyper-schema",
|
|
12386
|
+
"description": "An team app encapsulates the team specific functionality of Heroku apps.",
|
|
12387
|
+
"stability": "development",
|
|
12388
|
+
"title": "Heroku Platform API - Team App",
|
|
12389
|
+
"type": [
|
|
12390
|
+
"object"
|
|
12391
|
+
],
|
|
12392
|
+
"definitions": {
|
|
12393
|
+
"locked": {
|
|
12394
|
+
"default": false,
|
|
12395
|
+
"description": "are other team members forbidden from joining this app.",
|
|
12396
|
+
"example": false,
|
|
12397
|
+
"type": [
|
|
12398
|
+
"boolean"
|
|
12399
|
+
]
|
|
12400
|
+
},
|
|
12401
|
+
"identity": {
|
|
12402
|
+
"anyOf": [
|
|
12403
|
+
{
|
|
12404
|
+
"$ref": "#/definitions/app/definitions/name"
|
|
12405
|
+
}
|
|
12406
|
+
]
|
|
12407
|
+
},
|
|
12408
|
+
"joined": {
|
|
12409
|
+
"default": false,
|
|
12410
|
+
"description": "is the current member a collaborator on this app.",
|
|
12411
|
+
"example": false,
|
|
12412
|
+
"type": [
|
|
12413
|
+
"boolean"
|
|
12414
|
+
]
|
|
12415
|
+
},
|
|
12416
|
+
"personal": {
|
|
12417
|
+
"default": false,
|
|
12418
|
+
"description": "force creation of the app in the user account even if a default team is set.",
|
|
12419
|
+
"example": false,
|
|
12420
|
+
"type": [
|
|
12421
|
+
"boolean"
|
|
12422
|
+
]
|
|
12423
|
+
}
|
|
12424
|
+
},
|
|
12425
|
+
"links": [
|
|
12426
|
+
{
|
|
12427
|
+
"description": "Create a new app in the specified team, in the default team if unspecified, or in personal account, if default team is not set.",
|
|
12428
|
+
"href": "/teams/apps",
|
|
12429
|
+
"method": "POST",
|
|
12430
|
+
"rel": "create",
|
|
12431
|
+
"schema": {
|
|
12432
|
+
"properties": {
|
|
12433
|
+
"locked": {
|
|
12434
|
+
"$ref": "#/definitions/team-app/definitions/locked"
|
|
12435
|
+
},
|
|
12436
|
+
"name": {
|
|
12437
|
+
"$ref": "#/definitions/app/definitions/name"
|
|
12438
|
+
},
|
|
12439
|
+
"team": {
|
|
12440
|
+
"$ref": "#/definitions/team/definitions/name"
|
|
12441
|
+
},
|
|
12442
|
+
"personal": {
|
|
12443
|
+
"$ref": "#/definitions/team-app/definitions/personal"
|
|
12444
|
+
},
|
|
12445
|
+
"region": {
|
|
12446
|
+
"$ref": "#/definitions/region/definitions/name"
|
|
12447
|
+
},
|
|
12448
|
+
"space": {
|
|
12449
|
+
"$ref": "#/definitions/space/definitions/name"
|
|
12450
|
+
},
|
|
12451
|
+
"stack": {
|
|
12452
|
+
"$ref": "#/definitions/stack/definitions/name"
|
|
12453
|
+
}
|
|
12454
|
+
},
|
|
12455
|
+
"type": [
|
|
12456
|
+
"object"
|
|
12457
|
+
]
|
|
12458
|
+
},
|
|
12459
|
+
"title": "Create"
|
|
12460
|
+
},
|
|
12461
|
+
{
|
|
12462
|
+
"description": "List apps in the default team, or in personal account, if default team is not set.",
|
|
12463
|
+
"href": "/teams/apps",
|
|
12464
|
+
"method": "GET",
|
|
12465
|
+
"rel": "instances",
|
|
12466
|
+
"targetSchema": {
|
|
12467
|
+
"items": {
|
|
12468
|
+
"$ref": "#/definitions/team-app"
|
|
12469
|
+
},
|
|
12470
|
+
"type": [
|
|
12471
|
+
"array"
|
|
12472
|
+
]
|
|
12473
|
+
},
|
|
12474
|
+
"title": "List"
|
|
12475
|
+
},
|
|
12476
|
+
{
|
|
12477
|
+
"description": "Info for a team app.",
|
|
12478
|
+
"href": "/teams/apps/{(%23%2Fdefinitions%2Fteam-app%2Fdefinitions%2Fidentity)}",
|
|
12479
|
+
"method": "GET",
|
|
12480
|
+
"rel": "self",
|
|
12481
|
+
"title": "Info"
|
|
12482
|
+
},
|
|
12483
|
+
{
|
|
12484
|
+
"description": "Lock or unlock a team app.",
|
|
12485
|
+
"href": "/teams/apps/{(%23%2Fdefinitions%2Fteam-app%2Fdefinitions%2Fidentity)}",
|
|
12486
|
+
"method": "PATCH",
|
|
12487
|
+
"rel": "update",
|
|
12488
|
+
"schema": {
|
|
12489
|
+
"properties": {
|
|
12490
|
+
"locked": {
|
|
12491
|
+
"$ref": "#/definitions/team-app/definitions/locked"
|
|
12492
|
+
}
|
|
12493
|
+
},
|
|
12494
|
+
"required": [
|
|
12495
|
+
"locked"
|
|
12496
|
+
],
|
|
12497
|
+
"type": [
|
|
12498
|
+
"object"
|
|
12499
|
+
]
|
|
12500
|
+
},
|
|
12501
|
+
"targetSchema": {
|
|
12502
|
+
"$ref": "#/definitions/team-app"
|
|
12503
|
+
},
|
|
12504
|
+
"title": "Update Locked"
|
|
12505
|
+
},
|
|
12506
|
+
{
|
|
12507
|
+
"description": "Transfer an existing team app to another Heroku account.",
|
|
12508
|
+
"href": "/teams/apps/{(%23%2Fdefinitions%2Fteam-app%2Fdefinitions%2Fidentity)}",
|
|
12509
|
+
"method": "PATCH",
|
|
12510
|
+
"rel": "update",
|
|
12511
|
+
"schema": {
|
|
12512
|
+
"properties": {
|
|
12513
|
+
"owner": {
|
|
12514
|
+
"$ref": "#/definitions/account/definitions/identity"
|
|
12515
|
+
}
|
|
12516
|
+
},
|
|
12517
|
+
"required": [
|
|
12518
|
+
"owner"
|
|
12519
|
+
],
|
|
12520
|
+
"type": [
|
|
12521
|
+
"object"
|
|
12522
|
+
]
|
|
12523
|
+
},
|
|
12524
|
+
"title": "Transfer to Account"
|
|
12525
|
+
},
|
|
12526
|
+
{
|
|
12527
|
+
"description": "Transfer an existing team app to another team.",
|
|
12528
|
+
"href": "/teams/apps/{(%23%2Fdefinitions%2Fteam-app%2Fdefinitions%2Fidentity)}",
|
|
12529
|
+
"method": "PATCH",
|
|
12530
|
+
"rel": "update",
|
|
12531
|
+
"schema": {
|
|
12532
|
+
"properties": {
|
|
12533
|
+
"owner": {
|
|
12534
|
+
"$ref": "#/definitions/team/definitions/name"
|
|
12535
|
+
}
|
|
12536
|
+
},
|
|
12537
|
+
"required": [
|
|
12538
|
+
"owner"
|
|
12539
|
+
],
|
|
12540
|
+
"type": [
|
|
12541
|
+
"object"
|
|
12542
|
+
]
|
|
12543
|
+
},
|
|
12544
|
+
"targetSchema": {
|
|
12545
|
+
"$ref": "#/definitions/team-app"
|
|
12546
|
+
},
|
|
12547
|
+
"title": "Transfer to Team"
|
|
12548
|
+
},
|
|
12549
|
+
{
|
|
12550
|
+
"description": "List team apps.",
|
|
12551
|
+
"href": "/teams/{(%23%2Fdefinitions%2Fteam%2Fdefinitions%2Fidentity)}/apps",
|
|
12552
|
+
"method": "GET",
|
|
12553
|
+
"rel": "instances",
|
|
12554
|
+
"targetSchema": {
|
|
12555
|
+
"items": {
|
|
12556
|
+
"$ref": "#/definitions/team-app"
|
|
12557
|
+
},
|
|
12558
|
+
"type": [
|
|
12559
|
+
"array"
|
|
12560
|
+
]
|
|
12561
|
+
},
|
|
12562
|
+
"title": "List By Team"
|
|
12563
|
+
}
|
|
12564
|
+
],
|
|
12565
|
+
"properties": {
|
|
12566
|
+
"archived_at": {
|
|
12567
|
+
"$ref": "#/definitions/app/definitions/archived_at"
|
|
12568
|
+
},
|
|
12569
|
+
"buildpack_provided_description": {
|
|
12570
|
+
"$ref": "#/definitions/app/definitions/buildpack_provided_description"
|
|
12571
|
+
},
|
|
12572
|
+
"created_at": {
|
|
12573
|
+
"$ref": "#/definitions/app/definitions/created_at"
|
|
12574
|
+
},
|
|
12575
|
+
"git_url": {
|
|
12576
|
+
"$ref": "#/definitions/app/definitions/git_url"
|
|
12577
|
+
},
|
|
12578
|
+
"id": {
|
|
12579
|
+
"$ref": "#/definitions/app/definitions/id"
|
|
12580
|
+
},
|
|
12581
|
+
"joined": {
|
|
12582
|
+
"$ref": "#/definitions/team-app/definitions/joined"
|
|
12583
|
+
},
|
|
12584
|
+
"locked": {
|
|
12585
|
+
"$ref": "#/definitions/team-app/definitions/locked"
|
|
12586
|
+
},
|
|
12587
|
+
"maintenance": {
|
|
12588
|
+
"$ref": "#/definitions/app/definitions/maintenance"
|
|
12589
|
+
},
|
|
12590
|
+
"name": {
|
|
12591
|
+
"$ref": "#/definitions/app/definitions/name"
|
|
12592
|
+
},
|
|
12593
|
+
"team": {
|
|
12594
|
+
"description": "team that owns this app",
|
|
12595
|
+
"properties": {
|
|
12596
|
+
"name": {
|
|
12597
|
+
"$ref": "#/definitions/team/definitions/name"
|
|
12598
|
+
}
|
|
12599
|
+
},
|
|
12600
|
+
"type": [
|
|
12601
|
+
"null",
|
|
12602
|
+
"object"
|
|
12603
|
+
]
|
|
12604
|
+
},
|
|
12605
|
+
"owner": {
|
|
12606
|
+
"description": "identity of app owner",
|
|
12607
|
+
"properties": {
|
|
12608
|
+
"email": {
|
|
12609
|
+
"$ref": "#/definitions/account/definitions/email"
|
|
12610
|
+
},
|
|
12611
|
+
"id": {
|
|
12612
|
+
"$ref": "#/definitions/account/definitions/id"
|
|
12613
|
+
}
|
|
12614
|
+
},
|
|
12615
|
+
"type": [
|
|
12616
|
+
"null",
|
|
12617
|
+
"object"
|
|
12618
|
+
]
|
|
12619
|
+
},
|
|
12620
|
+
"region": {
|
|
12621
|
+
"description": "identity of app region",
|
|
12622
|
+
"properties": {
|
|
12623
|
+
"id": {
|
|
12624
|
+
"$ref": "#/definitions/region/definitions/id"
|
|
12625
|
+
},
|
|
12626
|
+
"name": {
|
|
12627
|
+
"$ref": "#/definitions/region/definitions/name"
|
|
12628
|
+
}
|
|
12629
|
+
},
|
|
12630
|
+
"type": [
|
|
12631
|
+
"object"
|
|
12632
|
+
]
|
|
12633
|
+
},
|
|
12634
|
+
"released_at": {
|
|
12635
|
+
"$ref": "#/definitions/app/definitions/released_at"
|
|
12636
|
+
},
|
|
12637
|
+
"repo_size": {
|
|
12638
|
+
"$ref": "#/definitions/app/definitions/repo_size"
|
|
12639
|
+
},
|
|
12640
|
+
"slug_size": {
|
|
12641
|
+
"$ref": "#/definitions/app/definitions/slug_size"
|
|
12642
|
+
},
|
|
12643
|
+
"space": {
|
|
12644
|
+
"description": "identity of space",
|
|
12645
|
+
"properties": {
|
|
12646
|
+
"id": {
|
|
12647
|
+
"$ref": "#/definitions/space/definitions/id"
|
|
12648
|
+
},
|
|
12649
|
+
"name": {
|
|
12650
|
+
"$ref": "#/definitions/space/definitions/name"
|
|
12651
|
+
}
|
|
12652
|
+
},
|
|
12653
|
+
"type": [
|
|
12654
|
+
"null",
|
|
12655
|
+
"object"
|
|
12656
|
+
]
|
|
12657
|
+
},
|
|
12658
|
+
"stack": {
|
|
12659
|
+
"description": "identity of app stack",
|
|
12660
|
+
"properties": {
|
|
12661
|
+
"id": {
|
|
12662
|
+
"$ref": "#/definitions/stack/definitions/id"
|
|
12663
|
+
},
|
|
12664
|
+
"name": {
|
|
12665
|
+
"$ref": "#/definitions/stack/definitions/name"
|
|
12666
|
+
}
|
|
12667
|
+
},
|
|
12668
|
+
"type": [
|
|
12669
|
+
"object"
|
|
12670
|
+
]
|
|
12671
|
+
},
|
|
12672
|
+
"updated_at": {
|
|
12673
|
+
"$ref": "#/definitions/app/definitions/updated_at"
|
|
12674
|
+
},
|
|
12675
|
+
"web_url": {
|
|
12676
|
+
"$ref": "#/definitions/app/definitions/web_url"
|
|
12677
|
+
}
|
|
12678
|
+
}
|
|
12679
|
+
},
|
|
12680
|
+
"team-feature": {
|
|
12681
|
+
"description": "A team feature represents a feature enabled on a team account.",
|
|
12682
|
+
"$schema": "http://json-schema.org/draft-04/hyper-schema",
|
|
12683
|
+
"stability": "development",
|
|
12684
|
+
"strictProperties": true,
|
|
12685
|
+
"title": "Heroku Platform API - Team Feature",
|
|
12686
|
+
"type": [
|
|
12687
|
+
"object"
|
|
12688
|
+
],
|
|
12689
|
+
"definitions": {
|
|
12690
|
+
"created_at": {
|
|
12691
|
+
"description": "when team feature was created",
|
|
12692
|
+
"example": "2012-01-01T12:00:00Z",
|
|
12693
|
+
"format": "date-time",
|
|
12694
|
+
"readOnly": true,
|
|
12695
|
+
"type": [
|
|
12696
|
+
"string"
|
|
12697
|
+
]
|
|
12698
|
+
},
|
|
12699
|
+
"description": {
|
|
12700
|
+
"description": "description of team feature",
|
|
12701
|
+
"example": "Causes account to example.",
|
|
12702
|
+
"readOnly": true,
|
|
12703
|
+
"type": [
|
|
12704
|
+
"string"
|
|
12705
|
+
]
|
|
12706
|
+
},
|
|
12707
|
+
"doc_url": {
|
|
12708
|
+
"description": "documentation URL of team feature",
|
|
12709
|
+
"example": "http://devcenter.heroku.com/articles/example",
|
|
12710
|
+
"readOnly": true,
|
|
12711
|
+
"type": [
|
|
12712
|
+
"string"
|
|
12713
|
+
]
|
|
12714
|
+
},
|
|
12715
|
+
"enabled": {
|
|
12716
|
+
"description": "whether or not team feature has been enabled",
|
|
12717
|
+
"example": true,
|
|
12718
|
+
"readOnly": false,
|
|
12719
|
+
"type": [
|
|
12720
|
+
"boolean"
|
|
12721
|
+
]
|
|
12722
|
+
},
|
|
12723
|
+
"id": {
|
|
12724
|
+
"description": "unique identifier of team feature",
|
|
12725
|
+
"example": "01234567-89ab-cdef-0123-456789abcdef",
|
|
12726
|
+
"format": "uuid",
|
|
12727
|
+
"readOnly": true,
|
|
12728
|
+
"type": [
|
|
12729
|
+
"string"
|
|
12730
|
+
]
|
|
12731
|
+
},
|
|
12732
|
+
"identity": {
|
|
12733
|
+
"anyOf": [
|
|
12734
|
+
{
|
|
12735
|
+
"$ref": "#/definitions/team-feature/definitions/id"
|
|
12736
|
+
},
|
|
12737
|
+
{
|
|
12738
|
+
"$ref": "#/definitions/team-feature/definitions/name"
|
|
12739
|
+
}
|
|
12740
|
+
]
|
|
12741
|
+
},
|
|
12742
|
+
"name": {
|
|
12743
|
+
"description": "unique name of team feature",
|
|
12744
|
+
"example": "name",
|
|
12745
|
+
"readOnly": true,
|
|
12746
|
+
"type": [
|
|
12747
|
+
"string"
|
|
12748
|
+
]
|
|
12749
|
+
},
|
|
12750
|
+
"state": {
|
|
12751
|
+
"description": "state of team feature",
|
|
12752
|
+
"example": "public",
|
|
12753
|
+
"readOnly": true,
|
|
12754
|
+
"type": [
|
|
12755
|
+
"string"
|
|
12756
|
+
]
|
|
12757
|
+
},
|
|
12758
|
+
"updated_at": {
|
|
12759
|
+
"description": "when team feature was updated",
|
|
12760
|
+
"example": "2012-01-01T12:00:00Z",
|
|
12761
|
+
"format": "date-time",
|
|
12762
|
+
"readOnly": true,
|
|
12763
|
+
"type": [
|
|
12764
|
+
"string"
|
|
12765
|
+
]
|
|
12766
|
+
},
|
|
12767
|
+
"display_name": {
|
|
12768
|
+
"description": "user readable feature name",
|
|
12769
|
+
"example": "My Feature",
|
|
12770
|
+
"readOnly": true,
|
|
12771
|
+
"type": [
|
|
12772
|
+
"string"
|
|
12773
|
+
]
|
|
12774
|
+
},
|
|
12775
|
+
"feedback_email": {
|
|
12776
|
+
"description": "e-mail to send feedback about the feature",
|
|
12777
|
+
"example": "feedback@heroku.com",
|
|
12778
|
+
"readOnly": true,
|
|
12779
|
+
"type": [
|
|
12780
|
+
"string"
|
|
12781
|
+
]
|
|
12782
|
+
}
|
|
12783
|
+
},
|
|
12784
|
+
"links": [
|
|
12785
|
+
{
|
|
12786
|
+
"description": "Info for an existing team feature.",
|
|
12787
|
+
"href": "/teams/{(%23%2Fdefinitions%2Fteam%2Fdefinitions%2Fidentity)}/features/{(%23%2Fdefinitions%2Fteam-feature%2Fdefinitions%2Fidentity)}",
|
|
12788
|
+
"method": "GET",
|
|
12789
|
+
"rel": "self",
|
|
12790
|
+
"targetSchema": {
|
|
12791
|
+
"$ref": "#/definitions/team-feature"
|
|
12792
|
+
},
|
|
12793
|
+
"title": "Info"
|
|
12794
|
+
},
|
|
12795
|
+
{
|
|
12796
|
+
"description": "List existing team features.",
|
|
12797
|
+
"href": "/teams/{(%23%2Fdefinitions%2Fteam%2Fdefinitions%2Fidentity)}/features",
|
|
12798
|
+
"method": "GET",
|
|
12799
|
+
"rel": "instances",
|
|
12800
|
+
"targetSchema": {
|
|
12801
|
+
"items": {
|
|
12802
|
+
"$ref": "#/definitions/team-feature"
|
|
12803
|
+
},
|
|
12804
|
+
"type": [
|
|
12805
|
+
"array"
|
|
12806
|
+
]
|
|
12807
|
+
},
|
|
12808
|
+
"title": "List"
|
|
12809
|
+
}
|
|
12810
|
+
],
|
|
12811
|
+
"properties": {
|
|
12812
|
+
"created_at": {
|
|
12813
|
+
"$ref": "#/definitions/team-feature/definitions/created_at"
|
|
12814
|
+
},
|
|
12815
|
+
"description": {
|
|
12816
|
+
"$ref": "#/definitions/team-feature/definitions/description"
|
|
12817
|
+
},
|
|
12818
|
+
"doc_url": {
|
|
12819
|
+
"$ref": "#/definitions/team-feature/definitions/doc_url"
|
|
12820
|
+
},
|
|
12821
|
+
"enabled": {
|
|
12822
|
+
"$ref": "#/definitions/team-feature/definitions/enabled"
|
|
12823
|
+
},
|
|
12824
|
+
"id": {
|
|
12825
|
+
"$ref": "#/definitions/team-feature/definitions/id"
|
|
12826
|
+
},
|
|
12827
|
+
"name": {
|
|
12828
|
+
"$ref": "#/definitions/team-feature/definitions/name"
|
|
12829
|
+
},
|
|
12830
|
+
"state": {
|
|
12831
|
+
"$ref": "#/definitions/team-feature/definitions/state"
|
|
12832
|
+
},
|
|
12833
|
+
"updated_at": {
|
|
12834
|
+
"$ref": "#/definitions/team-feature/definitions/updated_at"
|
|
12835
|
+
},
|
|
12836
|
+
"display_name": {
|
|
12837
|
+
"$ref": "#/definitions/team-feature/definitions/display_name"
|
|
12838
|
+
},
|
|
12839
|
+
"feedback_email": {
|
|
12840
|
+
"$ref": "#/definitions/team-feature/definitions/feedback_email"
|
|
12841
|
+
}
|
|
12842
|
+
}
|
|
12843
|
+
},
|
|
12844
|
+
"team-invitation": {
|
|
12845
|
+
"description": "A team invitation represents an invite to a team.",
|
|
12846
|
+
"$schema": "http://json-schema.org/draft-04/hyper-schema",
|
|
12847
|
+
"stability": "development",
|
|
12848
|
+
"strictProperties": true,
|
|
12849
|
+
"title": "Heroku Platform API - Team Invitation",
|
|
12850
|
+
"type": [
|
|
12851
|
+
"object"
|
|
12852
|
+
],
|
|
12853
|
+
"definitions": {
|
|
12854
|
+
"created_at": {
|
|
12855
|
+
"description": "when invitation was created",
|
|
12856
|
+
"example": "2012-01-01T12:00:00Z",
|
|
12857
|
+
"format": "date-time",
|
|
12858
|
+
"readOnly": true,
|
|
12859
|
+
"type": [
|
|
12860
|
+
"string"
|
|
12861
|
+
]
|
|
12862
|
+
},
|
|
12863
|
+
"identity": {
|
|
12864
|
+
"anyOf": [
|
|
12865
|
+
{
|
|
12866
|
+
"$ref": "#/definitions/team-invitation/definitions/id"
|
|
12867
|
+
}
|
|
12868
|
+
]
|
|
12869
|
+
},
|
|
12870
|
+
"id": {
|
|
12871
|
+
"description": "unique identifier of an invitation",
|
|
12872
|
+
"example": "01234567-89ab-cdef-0123-456789abcdef",
|
|
12873
|
+
"format": "uuid",
|
|
12874
|
+
"readOnly": true,
|
|
12875
|
+
"type": [
|
|
12876
|
+
"string"
|
|
12877
|
+
]
|
|
12878
|
+
},
|
|
12879
|
+
"token": {
|
|
12880
|
+
"description": "special token for invitation",
|
|
12881
|
+
"example": "614ae25aa2d4802096cd7c18625b526c",
|
|
12882
|
+
"readOnly": true,
|
|
12883
|
+
"type": [
|
|
12884
|
+
"string"
|
|
12885
|
+
]
|
|
12886
|
+
},
|
|
12887
|
+
"updated_at": {
|
|
12888
|
+
"description": "when invitation was updated",
|
|
12889
|
+
"example": "2012-01-01T12:00:00Z",
|
|
12890
|
+
"format": "date-time",
|
|
12891
|
+
"readOnly": true,
|
|
12892
|
+
"type": [
|
|
12893
|
+
"string"
|
|
12894
|
+
]
|
|
12895
|
+
}
|
|
12896
|
+
},
|
|
12897
|
+
"links": [
|
|
12898
|
+
{
|
|
12899
|
+
"description": "Get a list of a team's Identity Providers",
|
|
12900
|
+
"title": "List",
|
|
12901
|
+
"href": "/teams/{(%23%2Fdefinitions%2Fteam%2Fdefinitions%2Fname)}/invitations",
|
|
12902
|
+
"method": "GET",
|
|
12903
|
+
"rel": "instances",
|
|
12904
|
+
"targetSchema": {
|
|
12905
|
+
"items": {
|
|
12906
|
+
"$ref": "#/definitions/team-invitation"
|
|
12907
|
+
},
|
|
12908
|
+
"type": [
|
|
12909
|
+
"array"
|
|
12910
|
+
]
|
|
12911
|
+
}
|
|
12912
|
+
},
|
|
12913
|
+
{
|
|
12914
|
+
"description": "Create Team Invitation",
|
|
12915
|
+
"title": "Create",
|
|
12916
|
+
"href": "/teams/{(%23%2Fdefinitions%2Fteam%2Fdefinitions%2Fidentity)}/invitations",
|
|
12917
|
+
"method": "PUT",
|
|
12918
|
+
"rel": "update",
|
|
12919
|
+
"schema": {
|
|
12920
|
+
"properties": {
|
|
12921
|
+
"email": {
|
|
12922
|
+
"$ref": "#/definitions/account/definitions/email"
|
|
12923
|
+
},
|
|
12924
|
+
"role": {
|
|
12925
|
+
"$ref": "#/definitions/team/definitions/role"
|
|
12926
|
+
}
|
|
12927
|
+
},
|
|
12928
|
+
"required": [
|
|
12929
|
+
"email",
|
|
12930
|
+
"role"
|
|
12931
|
+
],
|
|
12932
|
+
"type": [
|
|
12933
|
+
"object"
|
|
12934
|
+
]
|
|
12935
|
+
}
|
|
12936
|
+
},
|
|
12937
|
+
{
|
|
12938
|
+
"description": "Revoke a team invitation.",
|
|
12939
|
+
"title": "Revoke",
|
|
12940
|
+
"href": "/teams/{(%23%2Fdefinitions%2Fteam%2Fdefinitions%2Fidentity)}/invitations/{(%23%2Fdefinitions%2Fteam-invitation%2Fdefinitions%2Fidentity)}",
|
|
12941
|
+
"method": "DELETE",
|
|
12942
|
+
"rel": "self"
|
|
12943
|
+
},
|
|
12944
|
+
{
|
|
12945
|
+
"description": "Get an invitation by its token",
|
|
12946
|
+
"title": "Get",
|
|
12947
|
+
"href": "/teams/invitations/{(%23%2Fdefinitions%2Fteam-invitation%2Fdefinitions%2Ftoken)}",
|
|
12948
|
+
"method": "GET",
|
|
12949
|
+
"rel": "instances",
|
|
12950
|
+
"targetSchema": {
|
|
12951
|
+
"$ref": "#/definitions/team-invitation"
|
|
12952
|
+
}
|
|
12953
|
+
},
|
|
12954
|
+
{
|
|
12955
|
+
"description": "Accept Team Invitation",
|
|
12956
|
+
"title": "Accept",
|
|
12957
|
+
"href": "/teams/invitations/{(%23%2Fdefinitions%2Fteam-invitation%2Fdefinitions%2Ftoken)}/accept",
|
|
12958
|
+
"method": "POST",
|
|
12959
|
+
"rel": "create",
|
|
12960
|
+
"targetSchema": {
|
|
12961
|
+
"$ref": "#/definitions/team-member"
|
|
12962
|
+
}
|
|
12963
|
+
}
|
|
12964
|
+
],
|
|
12965
|
+
"properties": {
|
|
12966
|
+
"created_at": {
|
|
12967
|
+
"$ref": "#/definitions/team-invitation/definitions/created_at"
|
|
12968
|
+
},
|
|
12969
|
+
"id": {
|
|
12970
|
+
"$ref": "#/definitions/team-invitation/definitions/id"
|
|
12971
|
+
},
|
|
12972
|
+
"invited_by": {
|
|
12973
|
+
"properties": {
|
|
12974
|
+
"email": {
|
|
12975
|
+
"$ref": "#/definitions/account/definitions/email"
|
|
12976
|
+
},
|
|
12977
|
+
"id": {
|
|
12978
|
+
"$ref": "#/definitions/account/definitions/id"
|
|
12979
|
+
},
|
|
12980
|
+
"name": {
|
|
12981
|
+
"$ref": "#/definitions/account/definitions/name"
|
|
12982
|
+
}
|
|
12983
|
+
},
|
|
12984
|
+
"strictProperties": true,
|
|
12985
|
+
"type": [
|
|
12986
|
+
"object"
|
|
12987
|
+
]
|
|
12988
|
+
},
|
|
12989
|
+
"team": {
|
|
12990
|
+
"properties": {
|
|
12991
|
+
"id": {
|
|
12992
|
+
"$ref": "#/definitions/team/definitions/id"
|
|
12993
|
+
},
|
|
12994
|
+
"name": {
|
|
12995
|
+
"$ref": "#/definitions/team/definitions/name"
|
|
12996
|
+
}
|
|
12997
|
+
},
|
|
12998
|
+
"strictProperties": true,
|
|
12999
|
+
"type": [
|
|
13000
|
+
"object"
|
|
13001
|
+
]
|
|
13002
|
+
},
|
|
13003
|
+
"role": {
|
|
13004
|
+
"$ref": "#/definitions/team/definitions/role"
|
|
13005
|
+
},
|
|
13006
|
+
"updated_at": {
|
|
13007
|
+
"$ref": "#/definitions/team-invitation/definitions/updated_at"
|
|
13008
|
+
},
|
|
13009
|
+
"user": {
|
|
13010
|
+
"properties": {
|
|
13011
|
+
"email": {
|
|
13012
|
+
"$ref": "#/definitions/account/definitions/email"
|
|
13013
|
+
},
|
|
13014
|
+
"id": {
|
|
13015
|
+
"$ref": "#/definitions/account/definitions/id"
|
|
13016
|
+
},
|
|
13017
|
+
"name": {
|
|
13018
|
+
"$ref": "#/definitions/account/definitions/name"
|
|
13019
|
+
}
|
|
13020
|
+
},
|
|
13021
|
+
"strictProperties": true,
|
|
13022
|
+
"type": [
|
|
13023
|
+
"object"
|
|
13024
|
+
]
|
|
13025
|
+
}
|
|
13026
|
+
}
|
|
13027
|
+
},
|
|
13028
|
+
"team-invoice": {
|
|
13029
|
+
"$schema": "http://json-schema.org/draft-04/hyper-schema",
|
|
13030
|
+
"description": "A Team Invoice is an itemized bill of goods for a team which includes pricing and charges.",
|
|
13031
|
+
"stability": "development",
|
|
13032
|
+
"strictProperties": true,
|
|
13033
|
+
"title": "Heroku Platform API - Team Invoice",
|
|
13034
|
+
"type": [
|
|
13035
|
+
"object"
|
|
13036
|
+
],
|
|
13037
|
+
"definitions": {
|
|
13038
|
+
"addons_total": {
|
|
13039
|
+
"description": "total add-ons charges in on this invoice",
|
|
13040
|
+
"example": 25000,
|
|
13041
|
+
"readOnly": true,
|
|
13042
|
+
"type": [
|
|
13043
|
+
"integer"
|
|
13044
|
+
]
|
|
13045
|
+
},
|
|
13046
|
+
"database_total": {
|
|
13047
|
+
"description": "total database charges on this invoice",
|
|
13048
|
+
"example": 25000,
|
|
13049
|
+
"readOnly": true,
|
|
13050
|
+
"type": [
|
|
13051
|
+
"integer"
|
|
13052
|
+
]
|
|
13053
|
+
},
|
|
13054
|
+
"charges_total": {
|
|
13055
|
+
"description": "total charges on this invoice",
|
|
13056
|
+
"example": 0,
|
|
13057
|
+
"readOnly": true,
|
|
13058
|
+
"type": [
|
|
13059
|
+
"integer"
|
|
13060
|
+
]
|
|
13061
|
+
},
|
|
13062
|
+
"created_at": {
|
|
13063
|
+
"description": "when invoice was created",
|
|
13064
|
+
"example": "2012-01-01T12:00:00Z",
|
|
13065
|
+
"format": "date-time",
|
|
13066
|
+
"readOnly": true,
|
|
13067
|
+
"type": [
|
|
13068
|
+
"string"
|
|
13069
|
+
]
|
|
13070
|
+
},
|
|
13071
|
+
"credits_total": {
|
|
13072
|
+
"description": "total credits on this invoice",
|
|
13073
|
+
"example": 100000,
|
|
13074
|
+
"readOnly": true,
|
|
13075
|
+
"type": [
|
|
13076
|
+
"integer"
|
|
13077
|
+
]
|
|
13078
|
+
},
|
|
13079
|
+
"dyno_units": {
|
|
13080
|
+
"description": "total amount of dyno units consumed across dyno types.",
|
|
13081
|
+
"example": 1.92,
|
|
13082
|
+
"readOnly": true,
|
|
13083
|
+
"type": [
|
|
13084
|
+
"number"
|
|
13085
|
+
]
|
|
13086
|
+
},
|
|
13087
|
+
"id": {
|
|
13088
|
+
"description": "unique identifier of this invoice",
|
|
13089
|
+
"example": "01234567-89ab-cdef-0123-456789abcdef",
|
|
13090
|
+
"format": "uuid",
|
|
13091
|
+
"readOnly": true,
|
|
13092
|
+
"type": [
|
|
13093
|
+
"string"
|
|
13094
|
+
]
|
|
13095
|
+
},
|
|
13096
|
+
"identity": {
|
|
13097
|
+
"anyOf": [
|
|
13098
|
+
{
|
|
13099
|
+
"$ref": "#/definitions/team-invoice/definitions/number"
|
|
13100
|
+
}
|
|
13101
|
+
]
|
|
13102
|
+
},
|
|
13103
|
+
"number": {
|
|
13104
|
+
"description": "human readable invoice number",
|
|
13105
|
+
"example": 9403943,
|
|
13106
|
+
"readOnly": true,
|
|
13107
|
+
"type": [
|
|
13108
|
+
"integer"
|
|
13109
|
+
]
|
|
13110
|
+
},
|
|
13111
|
+
"payment_status": {
|
|
13112
|
+
"description": "status of the invoice payment",
|
|
13113
|
+
"example": "Paid",
|
|
13114
|
+
"readOnly": true,
|
|
13115
|
+
"type": [
|
|
13116
|
+
"string"
|
|
13117
|
+
]
|
|
13118
|
+
},
|
|
13119
|
+
"platform_total": {
|
|
13120
|
+
"description": "total platform charges on this invoice",
|
|
13121
|
+
"example": 50000,
|
|
13122
|
+
"readOnly": true,
|
|
13123
|
+
"type": [
|
|
13124
|
+
"integer"
|
|
13125
|
+
]
|
|
13126
|
+
},
|
|
13127
|
+
"period_end": {
|
|
13128
|
+
"description": "the ending date that the invoice covers",
|
|
13129
|
+
"example": "01/31/2014",
|
|
13130
|
+
"readOnly": true,
|
|
13131
|
+
"type": [
|
|
13132
|
+
"string"
|
|
13133
|
+
]
|
|
13134
|
+
},
|
|
13135
|
+
"period_start": {
|
|
13136
|
+
"description": "the starting date that this invoice covers",
|
|
13137
|
+
"example": "01/01/2014",
|
|
13138
|
+
"readOnly": true,
|
|
13139
|
+
"type": [
|
|
13140
|
+
"string"
|
|
13141
|
+
]
|
|
13142
|
+
},
|
|
13143
|
+
"state": {
|
|
13144
|
+
"description": "payment status for this invoice (pending, successful, failed)",
|
|
13145
|
+
"example": 1,
|
|
13146
|
+
"readOnly": true,
|
|
13147
|
+
"type": [
|
|
13148
|
+
"integer"
|
|
13149
|
+
]
|
|
13150
|
+
},
|
|
13151
|
+
"total": {
|
|
13152
|
+
"description": "combined total of charges and credits on this invoice",
|
|
13153
|
+
"example": 100000,
|
|
13154
|
+
"readOnly": true,
|
|
13155
|
+
"type": [
|
|
13156
|
+
"integer"
|
|
13157
|
+
]
|
|
13158
|
+
},
|
|
13159
|
+
"updated_at": {
|
|
13160
|
+
"description": "when invoice was updated",
|
|
13161
|
+
"example": "2012-01-01T12:00:00Z",
|
|
13162
|
+
"format": "date-time",
|
|
13163
|
+
"readOnly": true,
|
|
13164
|
+
"type": [
|
|
13165
|
+
"string"
|
|
13166
|
+
]
|
|
13167
|
+
},
|
|
13168
|
+
"weighted_dyno_hours": {
|
|
13169
|
+
"description": "The total amount of hours consumed across dyno types.",
|
|
13170
|
+
"example": 1488,
|
|
13171
|
+
"readOnly": true,
|
|
13172
|
+
"type": [
|
|
13173
|
+
"number"
|
|
13174
|
+
]
|
|
13175
|
+
}
|
|
13176
|
+
},
|
|
13177
|
+
"links": [
|
|
13178
|
+
{
|
|
13179
|
+
"description": "Info for existing invoice.",
|
|
13180
|
+
"href": "/teams/{(%23%2Fdefinitions%2Fteam%2Fdefinitions%2Fidentity)}/invoices/{(%23%2Fdefinitions%2Fteam-invoice%2Fdefinitions%2Fidentity)}",
|
|
13181
|
+
"method": "GET",
|
|
13182
|
+
"rel": "self",
|
|
13183
|
+
"targetSchema": {
|
|
13184
|
+
"$ref": "#/definitions/team-invoice"
|
|
13185
|
+
},
|
|
13186
|
+
"title": "Info"
|
|
13187
|
+
},
|
|
13188
|
+
{
|
|
13189
|
+
"description": "List existing invoices.",
|
|
13190
|
+
"href": "/teams/{(%23%2Fdefinitions%2Fteam%2Fdefinitions%2Fidentity)}/invoices",
|
|
13191
|
+
"method": "GET",
|
|
13192
|
+
"rel": "instances",
|
|
13193
|
+
"targetSchema": {
|
|
13194
|
+
"items": {
|
|
13195
|
+
"$ref": "#/definitions/team-invoice"
|
|
13196
|
+
},
|
|
13197
|
+
"type": [
|
|
13198
|
+
"array"
|
|
13199
|
+
]
|
|
13200
|
+
},
|
|
13201
|
+
"title": "List"
|
|
13202
|
+
}
|
|
13203
|
+
],
|
|
13204
|
+
"properties": {
|
|
13205
|
+
"addons_total": {
|
|
13206
|
+
"$ref": "#/definitions/team-invoice/definitions/addons_total"
|
|
13207
|
+
},
|
|
13208
|
+
"database_total": {
|
|
13209
|
+
"$ref": "#/definitions/team-invoice/definitions/database_total"
|
|
13210
|
+
},
|
|
13211
|
+
"charges_total": {
|
|
13212
|
+
"$ref": "#/definitions/team-invoice/definitions/charges_total"
|
|
13213
|
+
},
|
|
13214
|
+
"created_at": {
|
|
13215
|
+
"$ref": "#/definitions/team-invoice/definitions/created_at"
|
|
13216
|
+
},
|
|
13217
|
+
"credits_total": {
|
|
13218
|
+
"$ref": "#/definitions/team-invoice/definitions/credits_total"
|
|
13219
|
+
},
|
|
13220
|
+
"dyno_units": {
|
|
13221
|
+
"$ref": "#/definitions/team-invoice/definitions/dyno_units"
|
|
13222
|
+
},
|
|
13223
|
+
"id": {
|
|
13224
|
+
"$ref": "#/definitions/team-invoice/definitions/id"
|
|
13225
|
+
},
|
|
13226
|
+
"number": {
|
|
13227
|
+
"$ref": "#/definitions/team-invoice/definitions/number"
|
|
13228
|
+
},
|
|
13229
|
+
"payment_status": {
|
|
13230
|
+
"$ref": "#/definitions/team-invoice/definitions/payment_status"
|
|
13231
|
+
},
|
|
13232
|
+
"period_end": {
|
|
13233
|
+
"$ref": "#/definitions/team-invoice/definitions/period_end"
|
|
13234
|
+
},
|
|
13235
|
+
"period_start": {
|
|
13236
|
+
"$ref": "#/definitions/team-invoice/definitions/period_start"
|
|
13237
|
+
},
|
|
13238
|
+
"platform_total": {
|
|
13239
|
+
"$ref": "#/definitions/team-invoice/definitions/platform_total"
|
|
13240
|
+
},
|
|
13241
|
+
"state": {
|
|
13242
|
+
"$ref": "#/definitions/team-invoice/definitions/state"
|
|
13243
|
+
},
|
|
13244
|
+
"total": {
|
|
13245
|
+
"$ref": "#/definitions/team-invoice/definitions/total"
|
|
13246
|
+
},
|
|
13247
|
+
"updated_at": {
|
|
13248
|
+
"$ref": "#/definitions/team-invoice/definitions/updated_at"
|
|
13249
|
+
},
|
|
13250
|
+
"weighted_dyno_hours": {
|
|
13251
|
+
"$ref": "#/definitions/team-invoice/definitions/weighted_dyno_hours"
|
|
13252
|
+
}
|
|
13253
|
+
}
|
|
13254
|
+
},
|
|
13255
|
+
"team-member": {
|
|
13256
|
+
"$schema": "http://json-schema.org/draft-04/hyper-schema",
|
|
13257
|
+
"description": "A team member is an individual with access to a team.",
|
|
13258
|
+
"stability": "development",
|
|
13259
|
+
"additionalProperties": false,
|
|
13260
|
+
"required": [
|
|
13261
|
+
"created_at",
|
|
13262
|
+
"email",
|
|
13263
|
+
"federated",
|
|
13264
|
+
"updated_at"
|
|
13265
|
+
],
|
|
13266
|
+
"title": "Heroku Platform API - Team Member",
|
|
13267
|
+
"type": [
|
|
13268
|
+
"object"
|
|
13269
|
+
],
|
|
13270
|
+
"definitions": {
|
|
13271
|
+
"created_at": {
|
|
13272
|
+
"description": "when the membership record was created",
|
|
13273
|
+
"example": "2012-01-01T12:00:00Z",
|
|
13274
|
+
"format": "date-time",
|
|
13275
|
+
"readOnly": true,
|
|
13276
|
+
"type": [
|
|
13277
|
+
"string"
|
|
13278
|
+
]
|
|
13279
|
+
},
|
|
13280
|
+
"email": {
|
|
13281
|
+
"description": "email address of the team member",
|
|
13282
|
+
"example": "someone@example.org",
|
|
13283
|
+
"readOnly": true,
|
|
13284
|
+
"type": [
|
|
13285
|
+
"string"
|
|
13286
|
+
]
|
|
13287
|
+
},
|
|
13288
|
+
"federated": {
|
|
13289
|
+
"description": "whether the user is federated and belongs to an Identity Provider",
|
|
13290
|
+
"example": false,
|
|
13291
|
+
"readOnly": true,
|
|
13292
|
+
"type": [
|
|
13293
|
+
"boolean"
|
|
13294
|
+
]
|
|
13295
|
+
},
|
|
13296
|
+
"id": {
|
|
13297
|
+
"description": "unique identifier of the team member",
|
|
13298
|
+
"example": "01234567-89ab-cdef-0123-456789abcdef",
|
|
13299
|
+
"format": "uuid",
|
|
13300
|
+
"readOnly": true,
|
|
13301
|
+
"type": [
|
|
13302
|
+
"string"
|
|
13303
|
+
]
|
|
13304
|
+
},
|
|
13305
|
+
"identity": {
|
|
13306
|
+
"anyOf": [
|
|
13307
|
+
{
|
|
13308
|
+
"$ref": "#/definitions/team-member/definitions/email"
|
|
13309
|
+
},
|
|
13310
|
+
{
|
|
13311
|
+
"$ref": "#/definitions/team-member/definitions/id"
|
|
13312
|
+
}
|
|
13313
|
+
]
|
|
13314
|
+
},
|
|
13315
|
+
"name": {
|
|
13316
|
+
"description": "full name of the team member",
|
|
13317
|
+
"example": "Tina Edmonds",
|
|
13318
|
+
"readOnly": true,
|
|
13319
|
+
"type": [
|
|
13320
|
+
"string",
|
|
13321
|
+
"null"
|
|
13322
|
+
]
|
|
13323
|
+
},
|
|
13324
|
+
"two_factor_authentication": {
|
|
13325
|
+
"description": "whether the Enterprise team member has two factor authentication enabled",
|
|
13326
|
+
"example": true,
|
|
13327
|
+
"readOnly": true,
|
|
13328
|
+
"type": [
|
|
13329
|
+
"boolean"
|
|
13330
|
+
]
|
|
13331
|
+
},
|
|
13332
|
+
"updated_at": {
|
|
13333
|
+
"description": "when the membership record was updated",
|
|
13334
|
+
"example": "2012-01-01T12:00:00Z",
|
|
13335
|
+
"format": "date-time",
|
|
13336
|
+
"readOnly": true,
|
|
13337
|
+
"type": [
|
|
13338
|
+
"string"
|
|
13339
|
+
]
|
|
13340
|
+
}
|
|
13341
|
+
},
|
|
13342
|
+
"links": [
|
|
13343
|
+
{
|
|
13344
|
+
"description": "Create a new team member, or update their role.",
|
|
13345
|
+
"href": "/teams/{(%23%2Fdefinitions%2Fteam%2Fdefinitions%2Fidentity)}/members",
|
|
13346
|
+
"method": "PUT",
|
|
13347
|
+
"rel": "create",
|
|
13348
|
+
"schema": {
|
|
13349
|
+
"properties": {
|
|
13350
|
+
"email": {
|
|
13351
|
+
"$ref": "#/definitions/team-member/definitions/email"
|
|
13352
|
+
},
|
|
13353
|
+
"federated": {
|
|
13354
|
+
"$ref": "#/definitions/team-member/definitions/federated"
|
|
13355
|
+
},
|
|
13356
|
+
"role": {
|
|
13357
|
+
"$ref": "#/definitions/team/definitions/role"
|
|
13358
|
+
}
|
|
13359
|
+
},
|
|
13360
|
+
"required": [
|
|
13361
|
+
"email",
|
|
13362
|
+
"role"
|
|
13363
|
+
],
|
|
13364
|
+
"type": [
|
|
13365
|
+
"object"
|
|
13366
|
+
]
|
|
13367
|
+
},
|
|
13368
|
+
"targetSchema": {
|
|
13369
|
+
"$ref": "#/definitions/team-member"
|
|
13370
|
+
},
|
|
13371
|
+
"title": "Create or Update"
|
|
13372
|
+
},
|
|
13373
|
+
{
|
|
13374
|
+
"description": "Create a new team member.",
|
|
13375
|
+
"href": "/teams/{(%23%2Fdefinitions%2Fteam%2Fdefinitions%2Fidentity)}/members",
|
|
13376
|
+
"method": "POST",
|
|
13377
|
+
"rel": "create",
|
|
13378
|
+
"schema": {
|
|
13379
|
+
"properties": {
|
|
13380
|
+
"email": {
|
|
13381
|
+
"$ref": "#/definitions/team-member/definitions/email"
|
|
13382
|
+
},
|
|
13383
|
+
"federated": {
|
|
13384
|
+
"$ref": "#/definitions/team-member/definitions/federated"
|
|
13385
|
+
},
|
|
13386
|
+
"role": {
|
|
13387
|
+
"$ref": "#/definitions/team/definitions/role"
|
|
13388
|
+
}
|
|
13389
|
+
},
|
|
13390
|
+
"required": [
|
|
13391
|
+
"email",
|
|
13392
|
+
"role"
|
|
13393
|
+
],
|
|
13394
|
+
"type": [
|
|
13395
|
+
"object"
|
|
13396
|
+
]
|
|
13397
|
+
},
|
|
13398
|
+
"targetSchema": {
|
|
13399
|
+
"$ref": "#/definitions/team-member"
|
|
13400
|
+
},
|
|
13401
|
+
"title": "Create"
|
|
13402
|
+
},
|
|
13403
|
+
{
|
|
13404
|
+
"description": "Update a team member.",
|
|
13405
|
+
"href": "/teams/{(%23%2Fdefinitions%2Fteam%2Fdefinitions%2Fidentity)}/members",
|
|
13406
|
+
"method": "PATCH",
|
|
13407
|
+
"rel": "update",
|
|
13408
|
+
"schema": {
|
|
13409
|
+
"properties": {
|
|
13410
|
+
"email": {
|
|
13411
|
+
"$ref": "#/definitions/team-member/definitions/email"
|
|
13412
|
+
},
|
|
13413
|
+
"federated": {
|
|
13414
|
+
"$ref": "#/definitions/team-member/definitions/federated"
|
|
13415
|
+
},
|
|
13416
|
+
"role": {
|
|
13417
|
+
"$ref": "#/definitions/team/definitions/role"
|
|
13418
|
+
}
|
|
13419
|
+
},
|
|
13420
|
+
"required": [
|
|
13421
|
+
"email",
|
|
13422
|
+
"role"
|
|
13423
|
+
],
|
|
13424
|
+
"type": [
|
|
13425
|
+
"object"
|
|
13426
|
+
]
|
|
13427
|
+
},
|
|
13428
|
+
"targetSchema": {
|
|
13429
|
+
"$ref": "#/definitions/team-member"
|
|
13430
|
+
},
|
|
13431
|
+
"title": "Update"
|
|
13432
|
+
},
|
|
13433
|
+
{
|
|
13434
|
+
"description": "Remove a member from the team.",
|
|
13435
|
+
"href": "/teams/{(%23%2Fdefinitions%2Fteam%2Fdefinitions%2Fidentity)}/members/{(%23%2Fdefinitions%2Fteam-member%2Fdefinitions%2Fidentity)}",
|
|
13436
|
+
"method": "DELETE",
|
|
13437
|
+
"rel": "destroy",
|
|
13438
|
+
"targetSchema": {
|
|
13439
|
+
"$ref": "#/definitions/team-member"
|
|
13440
|
+
},
|
|
13441
|
+
"title": "Delete"
|
|
13442
|
+
},
|
|
13443
|
+
{
|
|
13444
|
+
"description": "List members of the team.",
|
|
13445
|
+
"href": "/teams/{(%23%2Fdefinitions%2Fteam%2Fdefinitions%2Fidentity)}/members",
|
|
13446
|
+
"method": "GET",
|
|
13447
|
+
"ranges": [
|
|
13448
|
+
"email"
|
|
13449
|
+
],
|
|
13450
|
+
"rel": "instances",
|
|
13451
|
+
"targetSchema": {
|
|
13452
|
+
"items": {
|
|
13453
|
+
"$ref": "#/definitions/team-member"
|
|
13454
|
+
},
|
|
13455
|
+
"type": [
|
|
13456
|
+
"array"
|
|
13457
|
+
]
|
|
13458
|
+
},
|
|
13459
|
+
"title": "List"
|
|
13460
|
+
},
|
|
13461
|
+
{
|
|
13462
|
+
"description": "List the apps of a team member.",
|
|
13463
|
+
"href": "/teams/{(%23%2Fdefinitions%2Fteam%2Fdefinitions%2Fidentity)}/members/{(%23%2Fdefinitions%2Fteam-member%2Fdefinitions%2Fidentity)}/apps",
|
|
13464
|
+
"method": "GET",
|
|
13465
|
+
"rel": "instances",
|
|
13466
|
+
"targetSchema": {
|
|
13467
|
+
"items": {
|
|
13468
|
+
"$ref": "#/definitions/team-app"
|
|
13469
|
+
},
|
|
13470
|
+
"type": [
|
|
13471
|
+
"array"
|
|
13472
|
+
]
|
|
13473
|
+
},
|
|
13474
|
+
"title": "List By Member"
|
|
13475
|
+
}
|
|
13476
|
+
],
|
|
13477
|
+
"properties": {
|
|
13478
|
+
"created_at": {
|
|
13479
|
+
"$ref": "#/definitions/team-member/definitions/created_at"
|
|
13480
|
+
},
|
|
13481
|
+
"email": {
|
|
13482
|
+
"$ref": "#/definitions/team-member/definitions/email"
|
|
13483
|
+
},
|
|
13484
|
+
"federated": {
|
|
13485
|
+
"$ref": "#/definitions/team-member/definitions/federated"
|
|
13486
|
+
},
|
|
13487
|
+
"id": {
|
|
13488
|
+
"$ref": "#/definitions/team-member/definitions/id"
|
|
13489
|
+
},
|
|
13490
|
+
"role": {
|
|
13491
|
+
"$ref": "#/definitions/team/definitions/role"
|
|
13492
|
+
},
|
|
13493
|
+
"two_factor_authentication": {
|
|
13494
|
+
"$ref": "#/definitions/team-member/definitions/two_factor_authentication"
|
|
13495
|
+
},
|
|
13496
|
+
"updated_at": {
|
|
13497
|
+
"$ref": "#/definitions/team-member/definitions/updated_at"
|
|
13498
|
+
},
|
|
13499
|
+
"user": {
|
|
13500
|
+
"description": "user information for the membership",
|
|
13501
|
+
"properties": {
|
|
13502
|
+
"email": {
|
|
13503
|
+
"$ref": "#/definitions/account/definitions/email"
|
|
13504
|
+
},
|
|
13505
|
+
"id": {
|
|
13506
|
+
"$ref": "#/definitions/account/definitions/id"
|
|
13507
|
+
},
|
|
13508
|
+
"name": {
|
|
13509
|
+
"$ref": "#/definitions/account/definitions/name"
|
|
13510
|
+
}
|
|
13511
|
+
},
|
|
13512
|
+
"strictProperties": true,
|
|
13513
|
+
"type": [
|
|
13514
|
+
"object"
|
|
13515
|
+
]
|
|
13516
|
+
}
|
|
13517
|
+
}
|
|
13518
|
+
},
|
|
13519
|
+
"team-preferences": {
|
|
13520
|
+
"description": "Tracks a Team's Preferences",
|
|
13521
|
+
"$schema": "http://json-schema.org/draft-04/hyper-schema",
|
|
13522
|
+
"stability": "development",
|
|
13523
|
+
"strictProperties": true,
|
|
13524
|
+
"title": "Heroku Platform API - Team Preferences",
|
|
13525
|
+
"type": [
|
|
13526
|
+
"object"
|
|
13527
|
+
],
|
|
13528
|
+
"definitions": {
|
|
13529
|
+
"default-permission": {
|
|
13530
|
+
"description": "The default permission used when adding new members to the team",
|
|
13531
|
+
"example": "member",
|
|
13532
|
+
"readOnly": false,
|
|
13533
|
+
"enum": [
|
|
13534
|
+
"admin",
|
|
13535
|
+
"member",
|
|
13536
|
+
"viewer",
|
|
13537
|
+
null
|
|
13538
|
+
],
|
|
13539
|
+
"type": [
|
|
13540
|
+
"null",
|
|
13541
|
+
"string"
|
|
13542
|
+
]
|
|
13543
|
+
},
|
|
13544
|
+
"identity": {
|
|
13545
|
+
"$ref": "#/definitions/team/definitions/identity"
|
|
13546
|
+
},
|
|
13547
|
+
"whitelisting-enabled": {
|
|
13548
|
+
"description": "Whether whitelisting rules should be applied to add-on installations",
|
|
13549
|
+
"example": true,
|
|
13550
|
+
"readOnly": false,
|
|
13551
|
+
"type": [
|
|
13552
|
+
"boolean",
|
|
13553
|
+
"null"
|
|
13554
|
+
]
|
|
13555
|
+
}
|
|
13556
|
+
},
|
|
13557
|
+
"links": [
|
|
13558
|
+
{
|
|
13559
|
+
"description": "Retrieve Team Preferences",
|
|
13560
|
+
"href": "/teams/{(%23%2Fdefinitions%2Fteam-preferences%2Fdefinitions%2Fidentity)}/preferences",
|
|
13561
|
+
"method": "GET",
|
|
13562
|
+
"rel": "self",
|
|
13563
|
+
"targetSchema": {
|
|
13564
|
+
"$ref": "#/definitions/team-preferences"
|
|
13565
|
+
},
|
|
13566
|
+
"title": "List"
|
|
13567
|
+
},
|
|
13568
|
+
{
|
|
13569
|
+
"description": "Update Team Preferences",
|
|
13570
|
+
"href": "/teams/{(%23%2Fdefinitions%2Fteam-preferences%2Fdefinitions%2Fidentity)}/preferences",
|
|
13571
|
+
"method": "PATCH",
|
|
13572
|
+
"rel": "update",
|
|
13573
|
+
"schema": {
|
|
13574
|
+
"type": [
|
|
13575
|
+
"object"
|
|
13576
|
+
],
|
|
13577
|
+
"properties": {
|
|
13578
|
+
"whitelisting-enabled": {
|
|
13579
|
+
"$ref": "#/definitions/team-preferences/definitions/whitelisting-enabled"
|
|
13580
|
+
}
|
|
13581
|
+
}
|
|
13582
|
+
},
|
|
13583
|
+
"targetSchema": {
|
|
13584
|
+
"$ref": "#/definitions/team-preferences"
|
|
13585
|
+
},
|
|
13586
|
+
"title": "Update"
|
|
13587
|
+
}
|
|
13588
|
+
],
|
|
13589
|
+
"properties": {
|
|
13590
|
+
"default-permission": {
|
|
13591
|
+
"$ref": "#/definitions/team-preferences/definitions/default-permission"
|
|
13592
|
+
},
|
|
13593
|
+
"whitelisting-enabled": {
|
|
13594
|
+
"$ref": "#/definitions/team-preferences/definitions/whitelisting-enabled"
|
|
13595
|
+
}
|
|
13596
|
+
}
|
|
13597
|
+
},
|
|
13598
|
+
"team": {
|
|
13599
|
+
"$schema": "http://json-schema.org/draft-04/hyper-schema",
|
|
13600
|
+
"description": "Teams allow you to manage access to a shared group of applications and other resources.",
|
|
13601
|
+
"stability": "development",
|
|
13602
|
+
"strictProperties": true,
|
|
13603
|
+
"title": "Heroku Platform API - Team",
|
|
13604
|
+
"type": [
|
|
13605
|
+
"object"
|
|
13606
|
+
],
|
|
13607
|
+
"definitions": {
|
|
13608
|
+
"created_at": {
|
|
13609
|
+
"description": "when the team was created",
|
|
13610
|
+
"example": "2012-01-01T12:00:00Z",
|
|
13611
|
+
"format": "date-time",
|
|
13612
|
+
"readOnly": true,
|
|
13613
|
+
"type": [
|
|
13614
|
+
"string"
|
|
13615
|
+
]
|
|
13616
|
+
},
|
|
13617
|
+
"credit_card_collections": {
|
|
13618
|
+
"description": "whether charges incurred by the team are paid by credit card.",
|
|
13619
|
+
"example": true,
|
|
13620
|
+
"readOnly": true,
|
|
13621
|
+
"type": [
|
|
13622
|
+
"boolean"
|
|
13623
|
+
]
|
|
13624
|
+
},
|
|
13625
|
+
"default": {
|
|
13626
|
+
"description": "whether to use this team when none is specified",
|
|
13627
|
+
"example": true,
|
|
13628
|
+
"readOnly": false,
|
|
13629
|
+
"type": [
|
|
13630
|
+
"boolean"
|
|
13631
|
+
]
|
|
13632
|
+
},
|
|
13633
|
+
"id": {
|
|
13634
|
+
"description": "unique identifier of team",
|
|
13635
|
+
"example": "01234567-89ab-cdef-0123-456789abcdef",
|
|
13636
|
+
"format": "uuid",
|
|
13637
|
+
"readOnly": true,
|
|
13638
|
+
"type": [
|
|
13639
|
+
"string"
|
|
13640
|
+
]
|
|
13641
|
+
},
|
|
13642
|
+
"identity": {
|
|
13643
|
+
"anyOf": [
|
|
13644
|
+
{
|
|
13645
|
+
"$ref": "#/definitions/team/definitions/name"
|
|
13646
|
+
},
|
|
13647
|
+
{
|
|
13648
|
+
"$ref": "#/definitions/team/definitions/id"
|
|
13649
|
+
}
|
|
13650
|
+
]
|
|
13651
|
+
},
|
|
13652
|
+
"address_1": {
|
|
13653
|
+
"type": [
|
|
13654
|
+
"string"
|
|
13655
|
+
],
|
|
13656
|
+
"description": "street address line 1",
|
|
13657
|
+
"example": "40 Hickory Lane"
|
|
13658
|
+
},
|
|
13659
|
+
"address_2": {
|
|
13660
|
+
"type": [
|
|
13661
|
+
"string"
|
|
13662
|
+
],
|
|
13663
|
+
"description": "street address line 2",
|
|
13664
|
+
"example": "Suite 103"
|
|
13665
|
+
},
|
|
13666
|
+
"card_number": {
|
|
13667
|
+
"type": [
|
|
13668
|
+
"string"
|
|
13669
|
+
],
|
|
13670
|
+
"description": "encrypted card number of payment method",
|
|
13671
|
+
"example": "encrypted-card-number"
|
|
13672
|
+
},
|
|
13673
|
+
"city": {
|
|
13674
|
+
"type": [
|
|
13675
|
+
"string"
|
|
13676
|
+
],
|
|
13677
|
+
"description": "city",
|
|
13678
|
+
"example": "San Francisco"
|
|
13679
|
+
},
|
|
13680
|
+
"country": {
|
|
13681
|
+
"type": [
|
|
13682
|
+
"string"
|
|
13683
|
+
],
|
|
13684
|
+
"description": "country",
|
|
13685
|
+
"example": "US"
|
|
13686
|
+
},
|
|
13687
|
+
"cvv": {
|
|
13688
|
+
"type": [
|
|
13689
|
+
"string"
|
|
13690
|
+
],
|
|
13691
|
+
"description": "card verification value",
|
|
13692
|
+
"example": "123"
|
|
13693
|
+
},
|
|
13694
|
+
"expiration_month": {
|
|
13695
|
+
"type": [
|
|
13696
|
+
"string"
|
|
13697
|
+
],
|
|
13698
|
+
"description": "expiration month",
|
|
13699
|
+
"example": "11"
|
|
13700
|
+
},
|
|
13701
|
+
"expiration_year": {
|
|
13702
|
+
"type": [
|
|
13703
|
+
"string"
|
|
13704
|
+
],
|
|
13705
|
+
"description": "expiration year",
|
|
13706
|
+
"example": "2014"
|
|
13707
|
+
},
|
|
13708
|
+
"first_name": {
|
|
13709
|
+
"type": [
|
|
13710
|
+
"string"
|
|
13711
|
+
],
|
|
13712
|
+
"description": "the first name for payment method",
|
|
13713
|
+
"example": "Jason"
|
|
13714
|
+
},
|
|
13715
|
+
"last_name": {
|
|
13716
|
+
"type": [
|
|
13717
|
+
"string"
|
|
13718
|
+
],
|
|
13719
|
+
"description": "the last name for payment method",
|
|
13720
|
+
"example": "Walker"
|
|
13721
|
+
},
|
|
13722
|
+
"other": {
|
|
13723
|
+
"type": [
|
|
13724
|
+
"string"
|
|
13725
|
+
],
|
|
13726
|
+
"description": "metadata",
|
|
13727
|
+
"example": "Additional information for payment method"
|
|
13728
|
+
},
|
|
13729
|
+
"postal_code": {
|
|
13730
|
+
"type": [
|
|
13731
|
+
"string"
|
|
13732
|
+
],
|
|
13733
|
+
"description": "postal code",
|
|
13734
|
+
"example": "90210"
|
|
13735
|
+
},
|
|
13736
|
+
"state": {
|
|
13737
|
+
"type": [
|
|
13738
|
+
"string"
|
|
13739
|
+
],
|
|
13740
|
+
"description": "state",
|
|
13741
|
+
"example": "CA"
|
|
13742
|
+
},
|
|
13743
|
+
"membership_limit": {
|
|
13744
|
+
"description": "upper limit of members allowed in a team.",
|
|
13745
|
+
"example": 25,
|
|
13746
|
+
"readOnly": true,
|
|
13747
|
+
"type": [
|
|
13748
|
+
"number",
|
|
13749
|
+
"null"
|
|
13750
|
+
]
|
|
13751
|
+
},
|
|
13752
|
+
"name": {
|
|
13753
|
+
"description": "unique name of team",
|
|
13754
|
+
"example": "example",
|
|
13755
|
+
"readOnly": true,
|
|
13756
|
+
"type": [
|
|
13757
|
+
"string"
|
|
13758
|
+
]
|
|
13759
|
+
},
|
|
13760
|
+
"provisioned_licenses": {
|
|
13761
|
+
"description": "whether the team is provisioned licenses by salesforce.",
|
|
13762
|
+
"example": true,
|
|
13763
|
+
"readOnly": true,
|
|
13764
|
+
"type": [
|
|
13765
|
+
"boolean"
|
|
13766
|
+
]
|
|
13767
|
+
},
|
|
13768
|
+
"role": {
|
|
13769
|
+
"description": "role in the team",
|
|
13770
|
+
"enum": [
|
|
13771
|
+
"admin",
|
|
13772
|
+
"collaborator",
|
|
13773
|
+
"member",
|
|
13774
|
+
"owner",
|
|
13775
|
+
null
|
|
13776
|
+
],
|
|
13777
|
+
"example": "admin",
|
|
13778
|
+
"readOnly": true,
|
|
13779
|
+
"type": [
|
|
13780
|
+
"null",
|
|
13781
|
+
"string"
|
|
13782
|
+
]
|
|
13783
|
+
},
|
|
13784
|
+
"type": {
|
|
13785
|
+
"description": "type of team.",
|
|
13786
|
+
"example": "team",
|
|
13787
|
+
"enum": [
|
|
13788
|
+
"enterprise",
|
|
13789
|
+
"team"
|
|
13790
|
+
],
|
|
13791
|
+
"readOnly": true,
|
|
13792
|
+
"type": [
|
|
13793
|
+
"string"
|
|
13794
|
+
]
|
|
13795
|
+
},
|
|
13796
|
+
"updated_at": {
|
|
13797
|
+
"description": "when the team was updated",
|
|
13798
|
+
"example": "2012-01-01T12:00:00Z",
|
|
13799
|
+
"format": "date-time",
|
|
13800
|
+
"readOnly": true,
|
|
13801
|
+
"type": [
|
|
13802
|
+
"string"
|
|
13803
|
+
]
|
|
13804
|
+
}
|
|
13805
|
+
},
|
|
13806
|
+
"links": [
|
|
13807
|
+
{
|
|
13808
|
+
"description": "List teams in which you are a member.",
|
|
13809
|
+
"href": "/teams",
|
|
13810
|
+
"method": "GET",
|
|
13811
|
+
"rel": "instances",
|
|
13812
|
+
"targetSchema": {
|
|
13813
|
+
"items": {
|
|
13814
|
+
"$ref": "#/definitions/team"
|
|
13815
|
+
},
|
|
13816
|
+
"type": [
|
|
13817
|
+
"array"
|
|
13818
|
+
]
|
|
13819
|
+
},
|
|
13820
|
+
"title": "List"
|
|
13821
|
+
},
|
|
13822
|
+
{
|
|
13823
|
+
"description": "Info for a team.",
|
|
13824
|
+
"href": "/teams/{(%23%2Fdefinitions%2Fteam%2Fdefinitions%2Fidentity)}",
|
|
13825
|
+
"method": "GET",
|
|
13826
|
+
"rel": "self",
|
|
13827
|
+
"title": "Info"
|
|
13828
|
+
},
|
|
13829
|
+
{
|
|
13830
|
+
"description": "Update team properties.",
|
|
13831
|
+
"href": "/teams/{(%23%2Fdefinitions%2Fteam%2Fdefinitions%2Fidentity)}",
|
|
13832
|
+
"method": "PATCH",
|
|
13833
|
+
"rel": "update",
|
|
13834
|
+
"schema": {
|
|
13835
|
+
"properties": {
|
|
13836
|
+
"default": {
|
|
13837
|
+
"$ref": "#/definitions/team/definitions/default"
|
|
13838
|
+
},
|
|
13839
|
+
"name": {
|
|
13840
|
+
"$ref": "#/definitions/team/definitions/name"
|
|
13841
|
+
}
|
|
13842
|
+
},
|
|
13843
|
+
"type": [
|
|
13844
|
+
"object"
|
|
13845
|
+
]
|
|
13846
|
+
},
|
|
13847
|
+
"targetSchema": {
|
|
13848
|
+
"$ref": "#/definitions/team"
|
|
13849
|
+
},
|
|
13850
|
+
"title": "Update"
|
|
13851
|
+
},
|
|
13852
|
+
{
|
|
13853
|
+
"description": "Create a new team.",
|
|
13854
|
+
"href": "/teams",
|
|
13855
|
+
"method": "POST",
|
|
13856
|
+
"rel": "create",
|
|
13857
|
+
"schema": {
|
|
13858
|
+
"properties": {
|
|
13859
|
+
"name": {
|
|
13860
|
+
"$ref": "#/definitions/team/definitions/name"
|
|
13861
|
+
},
|
|
13862
|
+
"address_1": {
|
|
13863
|
+
"$ref": "#/definitions/team/definitions/address_1"
|
|
13864
|
+
},
|
|
13865
|
+
"address_2": {
|
|
13866
|
+
"$ref": "#/definitions/team/definitions/address_2"
|
|
13867
|
+
},
|
|
13868
|
+
"card_number": {
|
|
13869
|
+
"$ref": "#/definitions/team/definitions/card_number"
|
|
13870
|
+
},
|
|
13871
|
+
"city": {
|
|
13872
|
+
"$ref": "#/definitions/team/definitions/city"
|
|
13873
|
+
},
|
|
13874
|
+
"country": {
|
|
13875
|
+
"$ref": "#/definitions/team/definitions/country"
|
|
13876
|
+
},
|
|
13877
|
+
"cvv": {
|
|
13878
|
+
"$ref": "#/definitions/team/definitions/cvv"
|
|
13879
|
+
},
|
|
13880
|
+
"expiration_month": {
|
|
13881
|
+
"$ref": "#/definitions/team/definitions/expiration_month"
|
|
13882
|
+
},
|
|
13883
|
+
"expiration_year": {
|
|
13884
|
+
"$ref": "#/definitions/team/definitions/expiration_year"
|
|
13885
|
+
},
|
|
13886
|
+
"first_name": {
|
|
13887
|
+
"$ref": "#/definitions/team/definitions/first_name"
|
|
13888
|
+
},
|
|
13889
|
+
"last_name": {
|
|
13890
|
+
"$ref": "#/definitions/team/definitions/last_name"
|
|
13891
|
+
},
|
|
13892
|
+
"other": {
|
|
13893
|
+
"$ref": "#/definitions/team/definitions/other"
|
|
13894
|
+
},
|
|
13895
|
+
"postal_code": {
|
|
13896
|
+
"$ref": "#/definitions/team/definitions/postal_code"
|
|
13897
|
+
},
|
|
13898
|
+
"state": {
|
|
13899
|
+
"$ref": "#/definitions/team/definitions/state"
|
|
13900
|
+
}
|
|
13901
|
+
},
|
|
13902
|
+
"required": [
|
|
13903
|
+
"name"
|
|
13904
|
+
],
|
|
13905
|
+
"type": [
|
|
13906
|
+
"object"
|
|
13907
|
+
]
|
|
13908
|
+
},
|
|
13909
|
+
"targetSchema": {
|
|
13910
|
+
"$ref": "#/definitions/team"
|
|
13911
|
+
},
|
|
13912
|
+
"title": "Create"
|
|
13913
|
+
},
|
|
13914
|
+
{
|
|
13915
|
+
"description": "Delete an existing team.",
|
|
13916
|
+
"href": "/teams/{(%23%2Fdefinitions%2Fteam%2Fdefinitions%2Fidentity)}",
|
|
13917
|
+
"method": "DELETE",
|
|
13918
|
+
"rel": "destroy",
|
|
13919
|
+
"targetSchema": {
|
|
13920
|
+
"$ref": "#/definitions/team"
|
|
13921
|
+
},
|
|
13922
|
+
"title": "Delete"
|
|
13923
|
+
}
|
|
13924
|
+
],
|
|
13925
|
+
"properties": {
|
|
13926
|
+
"id": {
|
|
13927
|
+
"$ref": "#/definitions/team/definitions/id"
|
|
13928
|
+
},
|
|
13929
|
+
"created_at": {
|
|
13930
|
+
"$ref": "#/definitions/team/definitions/created_at"
|
|
13931
|
+
},
|
|
13932
|
+
"credit_card_collections": {
|
|
13933
|
+
"$ref": "#/definitions/team/definitions/credit_card_collections"
|
|
13934
|
+
},
|
|
13935
|
+
"default": {
|
|
13936
|
+
"$ref": "#/definitions/team/definitions/default"
|
|
13937
|
+
},
|
|
13938
|
+
"membership_limit": {
|
|
13939
|
+
"$ref": "#/definitions/team/definitions/membership_limit"
|
|
13940
|
+
},
|
|
13941
|
+
"name": {
|
|
13942
|
+
"$ref": "#/definitions/team/definitions/name"
|
|
13943
|
+
},
|
|
13944
|
+
"provisioned_licenses": {
|
|
13945
|
+
"$ref": "#/definitions/team/definitions/provisioned_licenses"
|
|
13946
|
+
},
|
|
13947
|
+
"role": {
|
|
13948
|
+
"$ref": "#/definitions/team/definitions/role"
|
|
13949
|
+
},
|
|
13950
|
+
"type": {
|
|
13951
|
+
"$ref": "#/definitions/team/definitions/type"
|
|
13952
|
+
},
|
|
13953
|
+
"updated_at": {
|
|
13954
|
+
"$ref": "#/definitions/team/definitions/updated_at"
|
|
13955
|
+
}
|
|
13956
|
+
}
|
|
13957
|
+
},
|
|
13958
|
+
"user-preferences": {
|
|
13959
|
+
"description": "Tracks a user's preferences and message dismissals",
|
|
13960
|
+
"$schema": "http://json-schema.org/draft-04/hyper-schema",
|
|
13961
|
+
"stability": "production",
|
|
13962
|
+
"strictProperties": true,
|
|
13963
|
+
"title": "Heroku Platform API - User Preferences",
|
|
13964
|
+
"type": [
|
|
13965
|
+
"object"
|
|
13966
|
+
],
|
|
13967
|
+
"definitions": {
|
|
13968
|
+
"identity": {
|
|
13969
|
+
"anyOf": [
|
|
13970
|
+
{
|
|
13971
|
+
"$ref": "#/definitions/user-preferences/definitions/self"
|
|
13972
|
+
}
|
|
13973
|
+
]
|
|
13974
|
+
},
|
|
13975
|
+
"self": {
|
|
13976
|
+
"description": "Implicit reference to currently authorized user",
|
|
13977
|
+
"enum": [
|
|
13978
|
+
"~"
|
|
13979
|
+
],
|
|
13980
|
+
"example": "~",
|
|
13981
|
+
"readOnly": true,
|
|
13982
|
+
"type": [
|
|
13983
|
+
"string"
|
|
13984
|
+
]
|
|
13985
|
+
},
|
|
13986
|
+
"timezone": {
|
|
13987
|
+
"description": "User's default timezone",
|
|
13988
|
+
"example": "UTC",
|
|
13989
|
+
"readOnly": false,
|
|
13990
|
+
"type": [
|
|
13991
|
+
"string",
|
|
13992
|
+
"null"
|
|
13993
|
+
]
|
|
13994
|
+
},
|
|
13995
|
+
"default-organization": {
|
|
13996
|
+
"description": "User's default organization",
|
|
13997
|
+
"example": "sushi-inc",
|
|
13998
|
+
"readOnly": false,
|
|
13999
|
+
"type": [
|
|
14000
|
+
"string",
|
|
14001
|
+
"null"
|
|
14002
|
+
]
|
|
14003
|
+
},
|
|
14004
|
+
"dismissed-github-banner": {
|
|
14005
|
+
"description": "Whether the user has dismissed the GitHub link banner",
|
|
14006
|
+
"example": true,
|
|
14007
|
+
"readOnly": false,
|
|
14008
|
+
"type": [
|
|
14009
|
+
"boolean",
|
|
14010
|
+
"null"
|
|
14011
|
+
]
|
|
14012
|
+
},
|
|
14013
|
+
"dismissed-getting-started": {
|
|
14014
|
+
"description": "Whether the user has dismissed the getting started banner",
|
|
14015
|
+
"example": true,
|
|
14016
|
+
"readOnly": false,
|
|
14017
|
+
"type": [
|
|
14018
|
+
"boolean",
|
|
14019
|
+
"null"
|
|
14020
|
+
]
|
|
14021
|
+
},
|
|
14022
|
+
"dismissed-org-access-controls": {
|
|
14023
|
+
"description": "Whether the user has dismissed the Organization Access Controls banner",
|
|
14024
|
+
"example": true,
|
|
14025
|
+
"readOnly": false,
|
|
14026
|
+
"type": [
|
|
14027
|
+
"boolean",
|
|
14028
|
+
"null"
|
|
14029
|
+
]
|
|
14030
|
+
},
|
|
14031
|
+
"dismissed-org-wizard-notification": {
|
|
14032
|
+
"description": "Whether the user has dismissed the Organization Wizard",
|
|
14033
|
+
"example": true,
|
|
14034
|
+
"readOnly": false,
|
|
14035
|
+
"type": [
|
|
14036
|
+
"boolean",
|
|
14037
|
+
"null"
|
|
14038
|
+
]
|
|
14039
|
+
},
|
|
14040
|
+
"dismissed-pipelines-banner": {
|
|
14041
|
+
"description": "Whether the user has dismissed the Pipelines banner",
|
|
14042
|
+
"example": true,
|
|
14043
|
+
"readOnly": false,
|
|
14044
|
+
"type": [
|
|
14045
|
+
"boolean",
|
|
14046
|
+
"null"
|
|
14047
|
+
]
|
|
14048
|
+
},
|
|
14049
|
+
"dismissed-pipelines-github-banner": {
|
|
14050
|
+
"description": "Whether the user has dismissed the GitHub banner on a pipeline overview",
|
|
14051
|
+
"example": true,
|
|
14052
|
+
"readOnly": false,
|
|
14053
|
+
"type": [
|
|
14054
|
+
"boolean",
|
|
14055
|
+
"null"
|
|
14056
|
+
]
|
|
14057
|
+
},
|
|
14058
|
+
"dismissed-pipelines-github-banners": {
|
|
14059
|
+
"description": "Which pipeline uuids the user has dismissed the GitHub banner for",
|
|
14060
|
+
"example": [
|
|
14061
|
+
"96c68759-f310-4910-9867-e0b062064098"
|
|
14062
|
+
],
|
|
14063
|
+
"readOnly": false,
|
|
14064
|
+
"type": [
|
|
14065
|
+
"null",
|
|
14066
|
+
"array"
|
|
14067
|
+
],
|
|
14068
|
+
"items": {
|
|
14069
|
+
"$ref": "#/definitions/pipeline/definitions/id"
|
|
14070
|
+
}
|
|
14071
|
+
},
|
|
14072
|
+
"dismissed-sms-banner": {
|
|
14073
|
+
"description": "Whether the user has dismissed the 2FA SMS banner",
|
|
14074
|
+
"example": true,
|
|
14075
|
+
"readOnly": false,
|
|
14076
|
+
"type": [
|
|
14077
|
+
"boolean",
|
|
14078
|
+
"null"
|
|
14079
|
+
]
|
|
14080
|
+
}
|
|
14081
|
+
},
|
|
14082
|
+
"links": [
|
|
14083
|
+
{
|
|
14084
|
+
"description": "Retrieve User Preferences",
|
|
14085
|
+
"href": "/users/{(%23%2Fdefinitions%2Fuser-preferences%2Fdefinitions%2Fidentity)}/preferences",
|
|
14086
|
+
"method": "GET",
|
|
14087
|
+
"rel": "self",
|
|
14088
|
+
"targetSchema": {
|
|
14089
|
+
"$ref": "#/definitions/user-preferences"
|
|
14090
|
+
},
|
|
14091
|
+
"title": "List"
|
|
14092
|
+
},
|
|
14093
|
+
{
|
|
14094
|
+
"description": "Update User Preferences",
|
|
14095
|
+
"href": "/users/{(%23%2Fdefinitions%2Fuser-preferences%2Fdefinitions%2Fidentity)}/preferences",
|
|
14096
|
+
"method": "PATCH",
|
|
14097
|
+
"rel": "update",
|
|
14098
|
+
"schema": {
|
|
14099
|
+
"type": [
|
|
14100
|
+
"object"
|
|
14101
|
+
],
|
|
14102
|
+
"properties": {
|
|
14103
|
+
"timezone": {
|
|
14104
|
+
"$ref": "#/definitions/user-preferences/definitions/timezone"
|
|
14105
|
+
},
|
|
14106
|
+
"default-organization": {
|
|
14107
|
+
"$ref": "#/definitions/user-preferences/definitions/default-organization"
|
|
14108
|
+
},
|
|
14109
|
+
"dismissed-github-banner": {
|
|
14110
|
+
"$ref": "#/definitions/user-preferences/definitions/dismissed-github-banner"
|
|
14111
|
+
},
|
|
14112
|
+
"dismissed-getting-started": {
|
|
14113
|
+
"$ref": "#/definitions/user-preferences/definitions/dismissed-getting-started"
|
|
14114
|
+
},
|
|
14115
|
+
"dismissed-org-access-controls": {
|
|
14116
|
+
"$ref": "#/definitions/user-preferences/definitions/dismissed-org-access-controls"
|
|
14117
|
+
},
|
|
14118
|
+
"dismissed-org-wizard-notification": {
|
|
14119
|
+
"$ref": "#/definitions/user-preferences/definitions/dismissed-org-wizard-notification"
|
|
12012
14120
|
},
|
|
12013
14121
|
"dismissed-pipelines-banner": {
|
|
12014
14122
|
"$ref": "#/definitions/user-preferences/definitions/dismissed-pipelines-banner"
|
|
@@ -12157,7 +14265,7 @@
|
|
|
12157
14265
|
"array"
|
|
12158
14266
|
]
|
|
12159
14267
|
},
|
|
12160
|
-
"title": "List"
|
|
14268
|
+
"title": "List By Organization"
|
|
12161
14269
|
},
|
|
12162
14270
|
{
|
|
12163
14271
|
"description": "Whitelist an Add-on Service",
|
|
@@ -12165,6 +14273,9 @@
|
|
|
12165
14273
|
"method": "POST",
|
|
12166
14274
|
"rel": "create",
|
|
12167
14275
|
"schema": {
|
|
14276
|
+
"type": [
|
|
14277
|
+
"object"
|
|
14278
|
+
],
|
|
12168
14279
|
"properties": {
|
|
12169
14280
|
"addon_service": {
|
|
12170
14281
|
"description": "name of the Add-on to whitelist",
|
|
@@ -12183,7 +14294,7 @@
|
|
|
12183
14294
|
"array"
|
|
12184
14295
|
]
|
|
12185
14296
|
},
|
|
12186
|
-
"title": "Create"
|
|
14297
|
+
"title": "Create By Organization"
|
|
12187
14298
|
},
|
|
12188
14299
|
{
|
|
12189
14300
|
"description": "Remove a whitelisted entity",
|
|
@@ -12193,7 +14304,61 @@
|
|
|
12193
14304
|
"targetSchema": {
|
|
12194
14305
|
"$ref": "#/definitions/whitelisted-add-on-service"
|
|
12195
14306
|
},
|
|
12196
|
-
"title": "Delete"
|
|
14307
|
+
"title": "Delete By Organization"
|
|
14308
|
+
},
|
|
14309
|
+
{
|
|
14310
|
+
"description": "List all whitelisted Add-on Services for a Team",
|
|
14311
|
+
"href": "/teams/{(%23%2Fdefinitions%2Fteam%2Fdefinitions%2Fidentity)}/whitelisted-addon-services",
|
|
14312
|
+
"method": "GET",
|
|
14313
|
+
"rel": "instances",
|
|
14314
|
+
"targetSchema": {
|
|
14315
|
+
"items": {
|
|
14316
|
+
"$ref": "#/definitions/whitelisted-add-on-service"
|
|
14317
|
+
},
|
|
14318
|
+
"type": [
|
|
14319
|
+
"array"
|
|
14320
|
+
]
|
|
14321
|
+
},
|
|
14322
|
+
"title": "List By Team"
|
|
14323
|
+
},
|
|
14324
|
+
{
|
|
14325
|
+
"description": "Whitelist an Add-on Service",
|
|
14326
|
+
"href": "/teams/{(%23%2Fdefinitions%2Fteam%2Fdefinitions%2Fidentity)}/whitelisted-addon-services",
|
|
14327
|
+
"method": "POST",
|
|
14328
|
+
"rel": "create",
|
|
14329
|
+
"schema": {
|
|
14330
|
+
"type": [
|
|
14331
|
+
"object"
|
|
14332
|
+
],
|
|
14333
|
+
"properties": {
|
|
14334
|
+
"addon_service": {
|
|
14335
|
+
"description": "name of the Add-on to whitelist",
|
|
14336
|
+
"example": "heroku-postgresql",
|
|
14337
|
+
"type": [
|
|
14338
|
+
"string"
|
|
14339
|
+
]
|
|
14340
|
+
}
|
|
14341
|
+
}
|
|
14342
|
+
},
|
|
14343
|
+
"targetSchema": {
|
|
14344
|
+
"items": {
|
|
14345
|
+
"$ref": "#/definitions/whitelisted-add-on-service"
|
|
14346
|
+
},
|
|
14347
|
+
"type": [
|
|
14348
|
+
"array"
|
|
14349
|
+
]
|
|
14350
|
+
},
|
|
14351
|
+
"title": "Create By Team"
|
|
14352
|
+
},
|
|
14353
|
+
{
|
|
14354
|
+
"description": "Remove a whitelisted entity",
|
|
14355
|
+
"href": "/teams/{(%23%2Fdefinitions%2Fteam%2Fdefinitions%2Fidentity)}/whitelisted-addon-services/{(%23%2Fdefinitions%2Fwhitelisted-add-on-service%2Fdefinitions%2Fidentity)}",
|
|
14356
|
+
"method": "DELETE",
|
|
14357
|
+
"rel": "destroy",
|
|
14358
|
+
"targetSchema": {
|
|
14359
|
+
"$ref": "#/definitions/whitelisted-add-on-service"
|
|
14360
|
+
},
|
|
14361
|
+
"title": "Delete By Team"
|
|
12197
14362
|
}
|
|
12198
14363
|
],
|
|
12199
14364
|
"properties": {
|
|
@@ -12417,6 +14582,33 @@
|
|
|
12417
14582
|
"stack": {
|
|
12418
14583
|
"$ref": "#/definitions/stack"
|
|
12419
14584
|
},
|
|
14585
|
+
"team-app-collaborator": {
|
|
14586
|
+
"$ref": "#/definitions/team-app-collaborator"
|
|
14587
|
+
},
|
|
14588
|
+
"team-app-permission": {
|
|
14589
|
+
"$ref": "#/definitions/team-app-permission"
|
|
14590
|
+
},
|
|
14591
|
+
"team-app": {
|
|
14592
|
+
"$ref": "#/definitions/team-app"
|
|
14593
|
+
},
|
|
14594
|
+
"team-feature": {
|
|
14595
|
+
"$ref": "#/definitions/team-feature"
|
|
14596
|
+
},
|
|
14597
|
+
"team-invitation": {
|
|
14598
|
+
"$ref": "#/definitions/team-invitation"
|
|
14599
|
+
},
|
|
14600
|
+
"team-invoice": {
|
|
14601
|
+
"$ref": "#/definitions/team-invoice"
|
|
14602
|
+
},
|
|
14603
|
+
"team-member": {
|
|
14604
|
+
"$ref": "#/definitions/team-member"
|
|
14605
|
+
},
|
|
14606
|
+
"team-preferences": {
|
|
14607
|
+
"$ref": "#/definitions/team-preferences"
|
|
14608
|
+
},
|
|
14609
|
+
"team": {
|
|
14610
|
+
"$ref": "#/definitions/team"
|
|
14611
|
+
},
|
|
12420
14612
|
"user-preferences": {
|
|
12421
14613
|
"$ref": "#/definitions/user-preferences"
|
|
12422
14614
|
},
|