Skip to content

Commit a2976a2

Browse files
mathiasmathias
committed
Update schema
- Removes non-existent /teams/apps and /orgs/apps endpoints
1 parent ce7a6ee commit a2976a2

2 files changed

Lines changed: 68 additions & 77 deletions

File tree

‎lib/platform-api/client.rb‎

Lines changed: 38 additions & 44 deletions
Original file line numberDiff line numberDiff line change
@@ -82,7 +82,7 @@ def self.custom_options(options)
8282

8383
# Get the default options.
8484
def self.default_options
85-
default_headers = {"Accept"=>"application/vnd.heroku+json; version=3", "User-Agent"=>"platform-api/2.0.0"}
85+
default_headers = {"Accept"=>"application/vnd.heroku+json; version=3", "User-Agent"=>"platform-api/2.1.0"}
8686
{
8787
default_headers: default_headers,
8888
url: "https://api.heroku.com"
@@ -1696,6 +1696,13 @@ def info(app_id_or_app_name, log_drain_id_or_log_drain_url_or_log_drain_token)
16961696
@client.log_drain.info(app_id_or_app_name, log_drain_id_or_log_drain_url_or_log_drain_token)
16971697
end
16981698

1699+
# List existing log drains for an add-on.
1700+
#
1701+
# @param addon_id_or_addon_name: unique identifier of add-on or globally unique name of the add-on
1702+
def list_by_addon(addon_id_or_addon_name)
1703+
@client.log_drain.list_by_addon(addon_id_or_addon_name)
1704+
end
1705+
16991706
# List existing log drains.
17001707
#
17011708
# @param app_id_or_app_name: unique identifier of app or unique name of app
@@ -1909,11 +1916,6 @@ def create(body = {})
19091916
@client.organization_app.create(body)
19101917
end
19111918

1912-
# List apps in the default organization, or in personal account, if default organization is not set.
1913-
def list()
1914-
@client.organization_app.list()
1915-
end
1916-
19171919
# List organization apps.
19181920
#
19191921
# @param organization_name_or_organization_id: unique name of organization or unique identifier of organization
@@ -2808,11 +2810,6 @@ def create(body = {})
28082810
@client.team_app.create(body)
28092811
end
28102812

2811-
# List apps in the default team, or in personal account, if default team is not set.
2812-
def list()
2813-
@client.team_app.list()
2814-
end
2815-
28162813
# Info for a team app.
28172814
#
28182815
# @param app_name: unique name of app
@@ -9526,6 +9523,21 @@ def delete_by_team(team_name_or_team_id, whitelisted_addon_service_id_or_addon_s
95269523
},
95279524
"title": "Info"
95289525
},
9526+
{
9527+
"description": "List existing log drains for an add-on.",
9528+
"href": "/addons/{(%23%2Fdefinitions%2Fadd-on%2Fdefinitions%2Fidentity)}/log-drains",
9529+
"method": "GET",
9530+
"rel": "instances",
9531+
"targetSchema": {
9532+
"items": {
9533+
"$ref": "#/definitions/log-drain"
9534+
},
9535+
"type": [
9536+
"array"
9537+
]
9538+
},
9539+
"title": "List By Add-on"
9540+
},
95299541
{
95309542
"description": "List existing log drains.",
95319543
"href": "/apps/{(%23%2Fdefinitions%2Fapp%2Fdefinitions%2Fidentity)}/log-drains",
@@ -10714,21 +10726,6 @@ def delete_by_team(team_name_or_team_id, whitelisted_addon_service_id_or_addon_s
1071410726
},
1071510727
"title": "Create"
1071610728
},
10717-
{
10718-
"description": "List apps in the default organization, or in personal account, if default organization is not set.",
10719-
"href": "/organizations/apps",
10720-
"method": "GET",
10721-
"rel": "instances",
10722-
"targetSchema": {
10723-
"items": {
10724-
"$ref": "#/definitions/organization-app"
10725-
},
10726-
"type": [
10727-
"array"
10728-
]
10729-
},
10730-
"title": "List"
10731-
},
1073210729
{
1073310730
"description": "List organization apps.",
1073410731
"href": "/organizations/{(%23%2Fdefinitions%2Forganization%2Fdefinitions%2Fidentity)}/apps",
@@ -13809,6 +13806,15 @@ def delete_by_team(team_name_or_team_id, whitelisted_addon_service_id_or_addon_s
1380913806
"type": [
1381013807
"boolean"
1381113808
]
13809+
},
13810+
"output_stream_url": {
13811+
"description": "Release command output will be available from this URL as a stream. The stream is available as either `text/plain` or `text/event-stream`. Clients should be prepared to handle disconnects and can resume the stream by sending a `Range` header (for `text/plain`) or a `Last-Event-Id` header (for `text/event-stream`).",
13812+
"example": "https://release-output.heroku.com/streams/01234567-89ab-cdef-0123-456789abcdef",
13813+
"readOnly": true,
13814+
"type": [
13815+
"string",
13816+
"null"
13817+
]
1381213818
}
1381313819
},
1381413820
"links": [
@@ -13959,6 +13965,9 @@ def delete_by_team(team_name_or_team_id, whitelisted_addon_service_id_or_addon_s
1395913965
},
1396013966
"current": {
1396113967
"$ref": "#/definitions/release/definitions/current"
13968+
},
13969+
"output_stream_url": {
13970+
"$ref": "#/definitions/release/definitions/output_stream_url"
1396213971
}
1396313972
}
1396413973
},
@@ -14914,8 +14923,8 @@ def delete_by_team(team_name_or_team_id, whitelisted_addon_service_id_or_addon_s
1491414923
"name": {
1491514924
"$ref": "#/definitions/space/definitions/name"
1491614925
},
14917-
"organization": {
14918-
"$ref": "#/definitions/organization/definitions/name"
14926+
"team": {
14927+
"$ref": "#/definitions/team/definitions/name"
1491914928
},
1492014929
"region": {
1492114930
"$ref": "#/definitions/region/definitions/identity"
@@ -14926,7 +14935,7 @@ def delete_by_team(team_name_or_team_id, whitelisted_addon_service_id_or_addon_s
1492614935
},
1492714936
"required": [
1492814937
"name",
14929-
"organization"
14938+
"team"
1493014939
],
1493114940
"type": [
1493214941
"object"
@@ -15641,21 +15650,6 @@ def delete_by_team(team_name_or_team_id, whitelisted_addon_service_id_or_addon_s
1564115650
},
1564215651
"title": "Create"
1564315652
},
15644-
{
15645-
"description": "List apps in the default team, or in personal account, if default team is not set.",
15646-
"href": "/teams/apps",
15647-
"method": "GET",
15648-
"rel": "instances",
15649-
"targetSchema": {
15650-
"items": {
15651-
"$ref": "#/definitions/team-app"
15652-
},
15653-
"type": [
15654-
"array"
15655-
]
15656-
},
15657-
"title": "List"
15658-
},
1565915653
{
1566015654
"description": "Info for a team app.",
1566115655
"href": "/teams/apps/{(%23%2Fdefinitions%2Fteam-app%2Fdefinitions%2Fidentity)}",

‎schema.json‎

Lines changed: 30 additions & 33 deletions
Original file line numberDiff line numberDiff line change
@@ -6389,6 +6389,21 @@
63896389
},
63906390
"title": "Info"
63916391
},
6392+
{
6393+
"description": "List existing log drains for an add-on.",
6394+
"href": "/addons/{(%23%2Fdefinitions%2Fadd-on%2Fdefinitions%2Fidentity)}/log-drains",
6395+
"method": "GET",
6396+
"rel": "instances",
6397+
"targetSchema": {
6398+
"items": {
6399+
"$ref": "#/definitions/log-drain"
6400+
},
6401+
"type": [
6402+
"array"
6403+
]
6404+
},
6405+
"title": "List By Add-on"
6406+
},
63926407
{
63936408
"description": "List existing log drains.",
63946409
"href": "/apps/{(%23%2Fdefinitions%2Fapp%2Fdefinitions%2Fidentity)}/log-drains",
@@ -7576,21 +7591,6 @@
75767591
},
75777592
"title": "Create"
75787593
},
7579-
{
7580-
"description": "List apps in the default organization, or in personal account, if default organization is not set.",
7581-
"href": "/organizations/apps",
7582-
"method": "GET",
7583-
"rel": "instances",
7584-
"targetSchema": {
7585-
"items": {
7586-
"$ref": "#/definitions/organization-app"
7587-
},
7588-
"type": [
7589-
"array"
7590-
]
7591-
},
7592-
"title": "List"
7593-
},
75947594
{
75957595
"description": "List organization apps.",
75967596
"href": "/organizations/{(%23%2Fdefinitions%2Forganization%2Fdefinitions%2Fidentity)}/apps",
@@ -10671,6 +10671,15 @@
1067110671
"type": [
1067210672
"boolean"
1067310673
]
10674+
},
10675+
"output_stream_url": {
10676+
"description": "Release command output will be available from this URL as a stream. The stream is available as either `text/plain` or `text/event-stream`. Clients should be prepared to handle disconnects and can resume the stream by sending a `Range` header (for `text/plain`) or a `Last-Event-Id` header (for `text/event-stream`).",
10677+
"example": "https://release-output.heroku.com/streams/01234567-89ab-cdef-0123-456789abcdef",
10678+
"readOnly": true,
10679+
"type": [
10680+
"string",
10681+
"null"
10682+
]
1067410683
}
1067510684
},
1067610685
"links": [
@@ -10821,6 +10830,9 @@
1082110830
},
1082210831
"current": {
1082310832
"$ref": "#/definitions/release/definitions/current"
10833+
},
10834+
"output_stream_url": {
10835+
"$ref": "#/definitions/release/definitions/output_stream_url"
1082410836
}
1082510837
}
1082610838
},
@@ -11776,8 +11788,8 @@
1177611788
"name": {
1177711789
"$ref": "#/definitions/space/definitions/name"
1177811790
},
11779-
"organization": {
11780-
"$ref": "#/definitions/organization/definitions/name"
11791+
"team": {
11792+
"$ref": "#/definitions/team/definitions/name"
1178111793
},
1178211794
"region": {
1178311795
"$ref": "#/definitions/region/definitions/identity"
@@ -11788,7 +11800,7 @@
1178811800
},
1178911801
"required": [
1179011802
"name",
11791-
"organization"
11803+
"team"
1179211804
],
1179311805
"type": [
1179411806
"object"
@@ -12503,21 +12515,6 @@
1250312515
},
1250412516
"title": "Create"
1250512517
},
12506-
{
12507-
"description": "List apps in the default team, or in personal account, if default team is not set.",
12508-
"href": "/teams/apps",
12509-
"method": "GET",
12510-
"rel": "instances",
12511-
"targetSchema": {
12512-
"items": {
12513-
"$ref": "#/definitions/team-app"
12514-
},
12515-
"type": [
12516-
"array"
12517-
]
12518-
},
12519-
"title": "List"
12520-
},
1252112518
{
1252212519
"description": "Info for a team app.",
1252312520
"href": "/teams/apps/{(%23%2Fdefinitions%2Fteam-app%2Fdefinitions%2Fidentity)}",

0 commit comments

Comments
 (0)