platform-api 3.0.0.pre.1 → 3.0.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/.github/workflows/check_changelog.yml +3 -1
- data/lib/platform-api/client.rb +490 -332
- data/lib/platform-api/version.rb +1 -1
- data/schema.json +357 -220
- metadata +4 -4
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: ee0c328970505aab87e732a3030917e1a39a13ace925bee458a64e7c46e2b4a2
|
4
|
+
data.tar.gz: c6c5e31213b1cb83e778644602090eafb62fedd13f2e25705c65a9667b65f3ba
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: dc9b94a51665c7baa26970c7a29fb8aa73611150ace42da706c0cfff817761c92d5c6cceb283a6fc7bd0182bbf6eae6624008d07befd48ba1cd908640e1a57d9
|
7
|
+
data.tar.gz: 382c4beea5afac407fc0d34b88d9e376390a015fcf023bfe7bb422111785481e4752f73a810a353c37178f8d36925e97d1dc149273d07781524c42f52c842147
|
data/lib/platform-api/client.rb
CHANGED
@@ -83,7 +83,7 @@ module PlatformAPI
|
|
83
83
|
|
84
84
|
# Get the default options.
|
85
85
|
def self.default_options
|
86
|
-
default_headers = {"Accept"=>"application/vnd.heroku+json; version=3", "User-Agent"=>"platform-api/3.0.0
|
86
|
+
default_headers = {"Accept"=>"application/vnd.heroku+json; version=3", "User-Agent"=>"platform-api/3.0.0"}
|
87
87
|
{
|
88
88
|
default_headers: default_headers,
|
89
89
|
url: "https://api.heroku.com"
|
@@ -245,6 +245,13 @@ module PlatformAPI
|
|
245
245
|
@archive_resource ||= Archive.new(@client)
|
246
246
|
end
|
247
247
|
|
248
|
+
# An audit trail event represents some action on the platform
|
249
|
+
#
|
250
|
+
# @return [AuditTrailEvent]
|
251
|
+
def audit_trail_event
|
252
|
+
@audit_trail_event_resource ||= AuditTrailEvent.new(@client)
|
253
|
+
end
|
254
|
+
|
248
255
|
# A build represents the process of transforming a code tarball into a slug
|
249
256
|
#
|
250
257
|
# @return [Build]
|
@@ -329,13 +336,6 @@ module PlatformAPI
|
|
329
336
|
@enterprise_account_resource ||= EnterpriseAccount.new(@client)
|
330
337
|
end
|
331
338
|
|
332
|
-
# An audit trail event represents some action on the platform
|
333
|
-
#
|
334
|
-
# @return [Event]
|
335
|
-
def event
|
336
|
-
@event_resource ||= Event.new(@client)
|
337
|
-
end
|
338
|
-
|
339
339
|
# Filters are special endpoints to allow for API consumers to specify a subset of resources to consume in order to reduce the number of requests that are performed. Each filter endpoint endpoint is responsible for determining its supported request format. The endpoints are over POST in order to handle large request bodies without hitting request uri query length limitations, but the requests themselves are idempotent and will not have side effects.
|
340
340
|
#
|
341
341
|
# @return [FilterApps]
|
@@ -616,6 +616,13 @@ module PlatformAPI
|
|
616
616
|
@space_nat_resource ||= SpaceNat.new(@client)
|
617
617
|
end
|
618
618
|
|
619
|
+
# Space Topology provides you with a mechanism for viewing all the running dynos, formations and applications for a space. This is the same data thats used to power our DNS Service Discovery.
|
620
|
+
#
|
621
|
+
# @return [SpaceTopology]
|
622
|
+
def space_topology
|
623
|
+
@space_topology_resource ||= SpaceTopology.new(@client)
|
624
|
+
end
|
625
|
+
|
619
626
|
# Transfer spaces between enterprise teams with the same Enterprise Account.
|
620
627
|
#
|
621
628
|
# @return [SpaceTransfer]
|
@@ -1464,6 +1471,20 @@ module PlatformAPI
|
|
1464
1471
|
end
|
1465
1472
|
end
|
1466
1473
|
|
1474
|
+
# An audit trail event represents some action on the platform
|
1475
|
+
class AuditTrailEvent
|
1476
|
+
def initialize(client)
|
1477
|
+
@client = client
|
1478
|
+
end
|
1479
|
+
|
1480
|
+
# List existing events.
|
1481
|
+
#
|
1482
|
+
# @param enterprise_account_id: unique identifier of the enterprise account
|
1483
|
+
def list(enterprise_account_id)
|
1484
|
+
@client.audit_trail_event.list(enterprise_account_id)
|
1485
|
+
end
|
1486
|
+
end
|
1487
|
+
|
1467
1488
|
# A build represents the process of transforming a code tarball into a slug
|
1468
1489
|
class Build
|
1469
1490
|
def initialize(client)
|
@@ -1821,20 +1842,6 @@ module PlatformAPI
|
|
1821
1842
|
end
|
1822
1843
|
end
|
1823
1844
|
|
1824
|
-
# An audit trail event represents some action on the platform
|
1825
|
-
class Event
|
1826
|
-
def initialize(client)
|
1827
|
-
@client = client
|
1828
|
-
end
|
1829
|
-
|
1830
|
-
# List existing events.
|
1831
|
-
#
|
1832
|
-
# @param enterprise_account_id: unique identifier of the enterprise account
|
1833
|
-
def list(enterprise_account_id)
|
1834
|
-
@client.event.list(enterprise_account_id)
|
1835
|
-
end
|
1836
|
-
end
|
1837
|
-
|
1838
1845
|
# Filters are special endpoints to allow for API consumers to specify a subset of resources to consume in order to reduce the number of requests that are performed. Each filter endpoint endpoint is responsible for determining its supported request format. The endpoints are over POST in order to handle large request bodies without hitting request uri query length limitations, but the requests themselves are idempotent and will not have side effects.
|
1839
1846
|
class FilterApps
|
1840
1847
|
def initialize(client)
|
@@ -2907,6 +2914,20 @@ module PlatformAPI
|
|
2907
2914
|
end
|
2908
2915
|
end
|
2909
2916
|
|
2917
|
+
# Space Topology provides you with a mechanism for viewing all the running dynos, formations and applications for a space. This is the same data thats used to power our DNS Service Discovery.
|
2918
|
+
class SpaceTopology
|
2919
|
+
def initialize(client)
|
2920
|
+
@client = client
|
2921
|
+
end
|
2922
|
+
|
2923
|
+
# Current space topology
|
2924
|
+
#
|
2925
|
+
# @param space_id_or_space_name: unique identifier of space or unique name of space
|
2926
|
+
def topology(space_id_or_space_name)
|
2927
|
+
@client.space_topology.topology(space_id_or_space_name)
|
2928
|
+
end
|
2929
|
+
end
|
2930
|
+
|
2910
2931
|
# Transfer spaces between enterprise teams with the same Enterprise Account.
|
2911
2932
|
class SpaceTransfer
|
2912
2933
|
def initialize(client)
|
@@ -7712,6 +7733,222 @@ module PlatformAPI
|
|
7712
7733
|
}
|
7713
7734
|
}
|
7714
7735
|
},
|
7736
|
+
"audit-trail-event": {
|
7737
|
+
"$schema": "http://json-schema.org/draft-04/hyper-schema",
|
7738
|
+
"title": "Heroku Platform API - Audit Trail Event",
|
7739
|
+
"description": "An audit trail event represents some action on the platform",
|
7740
|
+
"stability": "development",
|
7741
|
+
"strictProperties": true,
|
7742
|
+
"type": [
|
7743
|
+
"object"
|
7744
|
+
],
|
7745
|
+
"definitions": {
|
7746
|
+
"id": {
|
7747
|
+
"description": "unique identifier of event",
|
7748
|
+
"readOnly": true,
|
7749
|
+
"format": "uuid",
|
7750
|
+
"type": [
|
7751
|
+
"string"
|
7752
|
+
]
|
7753
|
+
},
|
7754
|
+
"identity": {
|
7755
|
+
"anyOf": [
|
7756
|
+
{
|
7757
|
+
"$ref": "#/definitions/audit-trail-event/definitions/id"
|
7758
|
+
}
|
7759
|
+
]
|
7760
|
+
},
|
7761
|
+
"type": {
|
7762
|
+
"description": "type of event",
|
7763
|
+
"readOnly": true,
|
7764
|
+
"type": [
|
7765
|
+
"string"
|
7766
|
+
]
|
7767
|
+
},
|
7768
|
+
"action": {
|
7769
|
+
"description": "action for the event",
|
7770
|
+
"readOnly": true,
|
7771
|
+
"type": [
|
7772
|
+
"string"
|
7773
|
+
]
|
7774
|
+
},
|
7775
|
+
"actor": {
|
7776
|
+
"description": "user who caused event",
|
7777
|
+
"readOnly": true,
|
7778
|
+
"type": [
|
7779
|
+
"object"
|
7780
|
+
],
|
7781
|
+
"properties": {
|
7782
|
+
"id": {
|
7783
|
+
"format": "uuid",
|
7784
|
+
"type": [
|
7785
|
+
"string"
|
7786
|
+
]
|
7787
|
+
},
|
7788
|
+
"email": {
|
7789
|
+
"format": "email",
|
7790
|
+
"type": [
|
7791
|
+
"string"
|
7792
|
+
]
|
7793
|
+
}
|
7794
|
+
}
|
7795
|
+
},
|
7796
|
+
"app": {
|
7797
|
+
"description": "app upon which event took place",
|
7798
|
+
"readOnly": true,
|
7799
|
+
"type": [
|
7800
|
+
"object"
|
7801
|
+
],
|
7802
|
+
"properties": {
|
7803
|
+
"id": {
|
7804
|
+
"format": "uuid",
|
7805
|
+
"type": [
|
7806
|
+
"string"
|
7807
|
+
]
|
7808
|
+
},
|
7809
|
+
"name": {
|
7810
|
+
"type": [
|
7811
|
+
"string"
|
7812
|
+
]
|
7813
|
+
}
|
7814
|
+
}
|
7815
|
+
},
|
7816
|
+
"owner": {
|
7817
|
+
"description": "owner of the app targeted by the event",
|
7818
|
+
"readOnly": true,
|
7819
|
+
"type": [
|
7820
|
+
"object"
|
7821
|
+
],
|
7822
|
+
"properties": {
|
7823
|
+
"id": {
|
7824
|
+
"format": "uuid",
|
7825
|
+
"type": [
|
7826
|
+
"string"
|
7827
|
+
]
|
7828
|
+
},
|
7829
|
+
"email": {
|
7830
|
+
"format": "email",
|
7831
|
+
"type": [
|
7832
|
+
"string"
|
7833
|
+
]
|
7834
|
+
}
|
7835
|
+
}
|
7836
|
+
},
|
7837
|
+
"enterprise_account": {
|
7838
|
+
"description": "enterprise account on which the event happened",
|
7839
|
+
"readOnly": true,
|
7840
|
+
"type": [
|
7841
|
+
"object"
|
7842
|
+
],
|
7843
|
+
"properties": {
|
7844
|
+
"id": {
|
7845
|
+
"format": "uuid",
|
7846
|
+
"type": [
|
7847
|
+
"string"
|
7848
|
+
]
|
7849
|
+
},
|
7850
|
+
"name": {
|
7851
|
+
"type": [
|
7852
|
+
"string"
|
7853
|
+
]
|
7854
|
+
}
|
7855
|
+
}
|
7856
|
+
},
|
7857
|
+
"team": {
|
7858
|
+
"description": "team on which the event happened",
|
7859
|
+
"readOnly": true,
|
7860
|
+
"type": [
|
7861
|
+
"object"
|
7862
|
+
],
|
7863
|
+
"properties": {
|
7864
|
+
"id": {
|
7865
|
+
"format": "uuid",
|
7866
|
+
"type": [
|
7867
|
+
"string"
|
7868
|
+
]
|
7869
|
+
},
|
7870
|
+
"name": {
|
7871
|
+
"type": [
|
7872
|
+
"string"
|
7873
|
+
]
|
7874
|
+
}
|
7875
|
+
}
|
7876
|
+
},
|
7877
|
+
"request": {
|
7878
|
+
"description": "information about where the action was triggered",
|
7879
|
+
"readOnly": true,
|
7880
|
+
"type": [
|
7881
|
+
"object"
|
7882
|
+
],
|
7883
|
+
"properties": {
|
7884
|
+
"ip_address": {
|
7885
|
+
"format": "ipv4",
|
7886
|
+
"type": [
|
7887
|
+
"string"
|
7888
|
+
]
|
7889
|
+
}
|
7890
|
+
}
|
7891
|
+
},
|
7892
|
+
"data": {
|
7893
|
+
"description": "data specific to the event",
|
7894
|
+
"readOnly": true,
|
7895
|
+
"type": [
|
7896
|
+
"object"
|
7897
|
+
]
|
7898
|
+
},
|
7899
|
+
"created_at": {
|
7900
|
+
"description": "when event was created",
|
7901
|
+
"format": "date-time",
|
7902
|
+
"type": [
|
7903
|
+
"string"
|
7904
|
+
]
|
7905
|
+
}
|
7906
|
+
},
|
7907
|
+
"links": [
|
7908
|
+
{
|
7909
|
+
"description": "List existing events.",
|
7910
|
+
"href": "/enterprise-accounts/{(%23%2Fdefinitions%2Fenterprise-account%2Fdefinitions%2Fidentity)}/events",
|
7911
|
+
"method": "GET",
|
7912
|
+
"rel": "instances",
|
7913
|
+
"title": "List"
|
7914
|
+
}
|
7915
|
+
],
|
7916
|
+
"properties": {
|
7917
|
+
"created_at": {
|
7918
|
+
"$ref": "#/definitions/audit-trail-event/definitions/created_at"
|
7919
|
+
},
|
7920
|
+
"id": {
|
7921
|
+
"$ref": "#/definitions/audit-trail-event/definitions/id"
|
7922
|
+
},
|
7923
|
+
"type": {
|
7924
|
+
"$ref": "#/definitions/audit-trail-event/definitions/type"
|
7925
|
+
},
|
7926
|
+
"action": {
|
7927
|
+
"$ref": "#/definitions/audit-trail-event/definitions/action"
|
7928
|
+
},
|
7929
|
+
"actor": {
|
7930
|
+
"$ref": "#/definitions/audit-trail-event/definitions/actor"
|
7931
|
+
},
|
7932
|
+
"app": {
|
7933
|
+
"$ref": "#/definitions/audit-trail-event/definitions/app"
|
7934
|
+
},
|
7935
|
+
"owner": {
|
7936
|
+
"$ref": "#/definitions/audit-trail-event/definitions/owner"
|
7937
|
+
},
|
7938
|
+
"enterprise_account": {
|
7939
|
+
"$ref": "#/definitions/audit-trail-event/definitions/enterprise_account"
|
7940
|
+
},
|
7941
|
+
"team": {
|
7942
|
+
"$ref": "#/definitions/audit-trail-event/definitions/team"
|
7943
|
+
},
|
7944
|
+
"request": {
|
7945
|
+
"$ref": "#/definitions/audit-trail-event/definitions/request"
|
7946
|
+
},
|
7947
|
+
"data": {
|
7948
|
+
"$ref": "#/definitions/audit-trail-event/definitions/data"
|
7949
|
+
}
|
7950
|
+
}
|
7951
|
+
},
|
7715
7952
|
"build": {
|
7716
7953
|
"$schema": "http://json-schema.org/draft-04/hyper-schema",
|
7717
7954
|
"description": "A build represents the process of transforming a code tarball into a slug",
|
@@ -9878,343 +10115,127 @@ module PlatformAPI
|
|
9878
10115
|
},
|
9879
10116
|
"name": {
|
9880
10117
|
"description": "unique name of the enterprise account",
|
9881
|
-
"example": "example",
|
9882
|
-
"readOnly": true,
|
9883
|
-
"type": [
|
9884
|
-
"string"
|
9885
|
-
]
|
9886
|
-
},
|
9887
|
-
"updated_at": {
|
9888
|
-
"description": "when the enterprise account was updated",
|
9889
|
-
"example": "2012-01-01T12:00:00Z",
|
9890
|
-
"format": "date-time",
|
9891
|
-
"readOnly": true,
|
9892
|
-
"type": [
|
9893
|
-
"string"
|
9894
|
-
]
|
9895
|
-
},
|
9896
|
-
"permissions": {
|
9897
|
-
"description": "the current user's permissions for this enterprise account",
|
9898
|
-
"readOnly": true,
|
9899
|
-
"type": [
|
9900
|
-
"array"
|
9901
|
-
],
|
9902
|
-
"items": {
|
9903
|
-
"example": "view",
|
9904
|
-
"type": [
|
9905
|
-
"string"
|
9906
|
-
]
|
9907
|
-
}
|
9908
|
-
},
|
9909
|
-
"trial": {
|
9910
|
-
"description": "whether the enterprise account is a trial or not",
|
9911
|
-
"example": false,
|
9912
|
-
"readOnly": true,
|
9913
|
-
"type": [
|
9914
|
-
"boolean"
|
9915
|
-
]
|
9916
|
-
}
|
9917
|
-
},
|
9918
|
-
"links": [
|
9919
|
-
{
|
9920
|
-
"description": "List enterprise accounts in which you are a member.",
|
9921
|
-
"href": "/enterprise-accounts",
|
9922
|
-
"method": "GET",
|
9923
|
-
"rel": "instances",
|
9924
|
-
"targetSchema": {
|
9925
|
-
"items": {
|
9926
|
-
"$ref": "#/definitions/enterprise-account"
|
9927
|
-
},
|
9928
|
-
"type": [
|
9929
|
-
"array"
|
9930
|
-
]
|
9931
|
-
},
|
9932
|
-
"title": "List"
|
9933
|
-
},
|
9934
|
-
{
|
9935
|
-
"description": "Information about an enterprise account.",
|
9936
|
-
"href": "/enterprise-accounts/{(%23%2Fdefinitions%2Fenterprise-account%2Fdefinitions%2Fidentity)}",
|
9937
|
-
"method": "GET",
|
9938
|
-
"rel": "self",
|
9939
|
-
"title": "Info"
|
9940
|
-
},
|
9941
|
-
{
|
9942
|
-
"description": "Update enterprise account properties",
|
9943
|
-
"href": "/enterprise-accounts/{(%23%2Fdefinitions%2Fenterprise-account%2Fdefinitions%2Fidentity)}",
|
9944
|
-
"method": "PATCH",
|
9945
|
-
"schema": {
|
9946
|
-
"properties": {
|
9947
|
-
"name": {
|
9948
|
-
"$ref": "#/definitions/enterprise-account/definitions/name"
|
9949
|
-
}
|
9950
|
-
},
|
9951
|
-
"type": [
|
9952
|
-
"object"
|
9953
|
-
]
|
9954
|
-
},
|
9955
|
-
"targetSchema": {
|
9956
|
-
"$ref": "#/definitions/enterprise-account"
|
9957
|
-
},
|
9958
|
-
"title": "Update"
|
9959
|
-
}
|
9960
|
-
],
|
9961
|
-
"properties": {
|
9962
|
-
"id": {
|
9963
|
-
"$ref": "#/definitions/enterprise-account/definitions/id"
|
9964
|
-
},
|
9965
|
-
"created_at": {
|
9966
|
-
"$ref": "#/definitions/enterprise-account/definitions/created_at"
|
9967
|
-
},
|
9968
|
-
"name": {
|
9969
|
-
"$ref": "#/definitions/enterprise-account/definitions/name"
|
9970
|
-
},
|
9971
|
-
"updated_at": {
|
9972
|
-
"$ref": "#/definitions/enterprise-account/definitions/updated_at"
|
9973
|
-
},
|
9974
|
-
"permissions": {
|
9975
|
-
"$ref": "#/definitions/enterprise-account/definitions/permissions"
|
9976
|
-
},
|
9977
|
-
"trial": {
|
9978
|
-
"$ref": "#/definitions/enterprise-account/definitions/trial"
|
9979
|
-
},
|
9980
|
-
"identity_provider": {
|
9981
|
-
"description": "Identity Provider associated with the Enterprise Account",
|
9982
|
-
"strictProperties": true,
|
9983
|
-
"type": [
|
9984
|
-
"null",
|
9985
|
-
"object"
|
9986
|
-
],
|
9987
|
-
"properties": {
|
9988
|
-
"id": {
|
9989
|
-
"$ref": "#/definitions/identity-provider/definitions/id"
|
9990
|
-
},
|
9991
|
-
"name": {
|
9992
|
-
"description": "user-friendly unique identifier for this identity provider",
|
9993
|
-
"example": "acme-sso",
|
9994
|
-
"type": [
|
9995
|
-
"string"
|
9996
|
-
]
|
9997
|
-
},
|
9998
|
-
"owner": {
|
9999
|
-
"$ref": "#/definitions/identity-provider/definitions/owner"
|
10000
|
-
}
|
10001
|
-
}
|
10002
|
-
}
|
10003
|
-
}
|
10004
|
-
},
|
10005
|
-
"event": {
|
10006
|
-
"$schema": "http://json-schema.org/draft-04/hyper-schema",
|
10007
|
-
"title": "Heroku Platform API - Audit Trail Event",
|
10008
|
-
"description": "An audit trail event represents some action on the platform",
|
10009
|
-
"stability": "development",
|
10010
|
-
"strictProperties": true,
|
10011
|
-
"type": [
|
10012
|
-
"object"
|
10013
|
-
],
|
10014
|
-
"definitions": {
|
10015
|
-
"id": {
|
10016
|
-
"description": "unique identifier of event",
|
10017
|
-
"readOnly": true,
|
10018
|
-
"format": "uuid",
|
10019
|
-
"type": [
|
10020
|
-
"string"
|
10021
|
-
]
|
10022
|
-
},
|
10023
|
-
"identity": {
|
10024
|
-
"anyOf": [
|
10025
|
-
{
|
10026
|
-
"$ref": "#/definitions/event/definitions/id"
|
10027
|
-
}
|
10028
|
-
]
|
10029
|
-
},
|
10030
|
-
"type": {
|
10031
|
-
"description": "type of event",
|
10032
|
-
"readOnly": true,
|
10033
|
-
"type": [
|
10034
|
-
"string"
|
10035
|
-
]
|
10036
|
-
},
|
10037
|
-
"action": {
|
10038
|
-
"description": "action for the event",
|
10039
|
-
"readOnly": true,
|
10040
|
-
"type": [
|
10041
|
-
"string"
|
10042
|
-
]
|
10043
|
-
},
|
10044
|
-
"actor": {
|
10045
|
-
"description": "user who caused event",
|
10046
|
-
"readOnly": true,
|
10047
|
-
"type": [
|
10048
|
-
"object"
|
10049
|
-
],
|
10050
|
-
"properties": {
|
10051
|
-
"id": {
|
10052
|
-
"format": "uuid",
|
10053
|
-
"type": [
|
10054
|
-
"string"
|
10055
|
-
]
|
10056
|
-
},
|
10057
|
-
"email": {
|
10058
|
-
"format": "email",
|
10059
|
-
"type": [
|
10060
|
-
"string"
|
10061
|
-
]
|
10062
|
-
}
|
10063
|
-
}
|
10064
|
-
},
|
10065
|
-
"app": {
|
10066
|
-
"description": "app upon which event took place",
|
10067
|
-
"readOnly": true,
|
10068
|
-
"type": [
|
10069
|
-
"object"
|
10070
|
-
],
|
10071
|
-
"properties": {
|
10072
|
-
"id": {
|
10073
|
-
"format": "uuid",
|
10074
|
-
"type": [
|
10075
|
-
"string"
|
10076
|
-
]
|
10077
|
-
},
|
10078
|
-
"name": {
|
10079
|
-
"type": [
|
10080
|
-
"string"
|
10081
|
-
]
|
10082
|
-
}
|
10083
|
-
}
|
10084
|
-
},
|
10085
|
-
"owner": {
|
10086
|
-
"description": "owner of the app targeted by the event",
|
10087
|
-
"readOnly": true,
|
10088
|
-
"type": [
|
10089
|
-
"object"
|
10090
|
-
],
|
10091
|
-
"properties": {
|
10092
|
-
"id": {
|
10093
|
-
"format": "uuid",
|
10094
|
-
"type": [
|
10095
|
-
"string"
|
10096
|
-
]
|
10097
|
-
},
|
10098
|
-
"email": {
|
10099
|
-
"format": "email",
|
10100
|
-
"type": [
|
10101
|
-
"string"
|
10102
|
-
]
|
10103
|
-
}
|
10104
|
-
}
|
10105
|
-
},
|
10106
|
-
"enterprise_account": {
|
10107
|
-
"description": "enterprise account on which the event happened",
|
10118
|
+
"example": "example",
|
10108
10119
|
"readOnly": true,
|
10109
10120
|
"type": [
|
10110
|
-
"
|
10111
|
-
]
|
10112
|
-
"properties": {
|
10113
|
-
"id": {
|
10114
|
-
"format": "uuid",
|
10115
|
-
"type": [
|
10116
|
-
"string"
|
10117
|
-
]
|
10118
|
-
},
|
10119
|
-
"name": {
|
10120
|
-
"type": [
|
10121
|
-
"string"
|
10122
|
-
]
|
10123
|
-
}
|
10124
|
-
}
|
10121
|
+
"string"
|
10122
|
+
]
|
10125
10123
|
},
|
10126
|
-
"
|
10127
|
-
"description": "
|
10124
|
+
"updated_at": {
|
10125
|
+
"description": "when the enterprise account was updated",
|
10126
|
+
"example": "2012-01-01T12:00:00Z",
|
10127
|
+
"format": "date-time",
|
10128
10128
|
"readOnly": true,
|
10129
10129
|
"type": [
|
10130
|
-
"
|
10131
|
-
]
|
10132
|
-
"properties": {
|
10133
|
-
"id": {
|
10134
|
-
"format": "uuid",
|
10135
|
-
"type": [
|
10136
|
-
"string"
|
10137
|
-
]
|
10138
|
-
},
|
10139
|
-
"name": {
|
10140
|
-
"type": [
|
10141
|
-
"string"
|
10142
|
-
]
|
10143
|
-
}
|
10144
|
-
}
|
10130
|
+
"string"
|
10131
|
+
]
|
10145
10132
|
},
|
10146
|
-
"
|
10147
|
-
"description": "
|
10133
|
+
"permissions": {
|
10134
|
+
"description": "the current user's permissions for this enterprise account",
|
10148
10135
|
"readOnly": true,
|
10149
10136
|
"type": [
|
10150
|
-
"
|
10137
|
+
"array"
|
10151
10138
|
],
|
10152
|
-
"
|
10153
|
-
"
|
10154
|
-
|
10155
|
-
"
|
10156
|
-
|
10157
|
-
]
|
10158
|
-
}
|
10139
|
+
"items": {
|
10140
|
+
"example": "view",
|
10141
|
+
"type": [
|
10142
|
+
"string"
|
10143
|
+
]
|
10159
10144
|
}
|
10160
10145
|
},
|
10161
|
-
"
|
10162
|
-
"description": "
|
10146
|
+
"trial": {
|
10147
|
+
"description": "whether the enterprise account is a trial or not",
|
10148
|
+
"example": false,
|
10163
10149
|
"readOnly": true,
|
10164
10150
|
"type": [
|
10165
|
-
"
|
10166
|
-
]
|
10167
|
-
},
|
10168
|
-
"created_at": {
|
10169
|
-
"description": "when event was created",
|
10170
|
-
"format": "date-time",
|
10171
|
-
"type": [
|
10172
|
-
"string"
|
10151
|
+
"boolean"
|
10173
10152
|
]
|
10174
10153
|
}
|
10175
10154
|
},
|
10176
10155
|
"links": [
|
10177
10156
|
{
|
10178
|
-
"description": "List
|
10179
|
-
"href": "/enterprise-accounts
|
10157
|
+
"description": "List enterprise accounts in which you are a member.",
|
10158
|
+
"href": "/enterprise-accounts",
|
10180
10159
|
"method": "GET",
|
10181
10160
|
"rel": "instances",
|
10161
|
+
"targetSchema": {
|
10162
|
+
"items": {
|
10163
|
+
"$ref": "#/definitions/enterprise-account"
|
10164
|
+
},
|
10165
|
+
"type": [
|
10166
|
+
"array"
|
10167
|
+
]
|
10168
|
+
},
|
10182
10169
|
"title": "List"
|
10170
|
+
},
|
10171
|
+
{
|
10172
|
+
"description": "Information about an enterprise account.",
|
10173
|
+
"href": "/enterprise-accounts/{(%23%2Fdefinitions%2Fenterprise-account%2Fdefinitions%2Fidentity)}",
|
10174
|
+
"method": "GET",
|
10175
|
+
"rel": "self",
|
10176
|
+
"title": "Info"
|
10177
|
+
},
|
10178
|
+
{
|
10179
|
+
"description": "Update enterprise account properties",
|
10180
|
+
"href": "/enterprise-accounts/{(%23%2Fdefinitions%2Fenterprise-account%2Fdefinitions%2Fidentity)}",
|
10181
|
+
"method": "PATCH",
|
10182
|
+
"schema": {
|
10183
|
+
"properties": {
|
10184
|
+
"name": {
|
10185
|
+
"$ref": "#/definitions/enterprise-account/definitions/name"
|
10186
|
+
}
|
10187
|
+
},
|
10188
|
+
"type": [
|
10189
|
+
"object"
|
10190
|
+
]
|
10191
|
+
},
|
10192
|
+
"targetSchema": {
|
10193
|
+
"$ref": "#/definitions/enterprise-account"
|
10194
|
+
},
|
10195
|
+
"title": "Update"
|
10183
10196
|
}
|
10184
10197
|
],
|
10185
10198
|
"properties": {
|
10186
|
-
"created_at": {
|
10187
|
-
"$ref": "#/definitions/event/definitions/created_at"
|
10188
|
-
},
|
10189
10199
|
"id": {
|
10190
|
-
"$ref": "#/definitions/
|
10191
|
-
},
|
10192
|
-
"type": {
|
10193
|
-
"$ref": "#/definitions/event/definitions/type"
|
10194
|
-
},
|
10195
|
-
"action": {
|
10196
|
-
"$ref": "#/definitions/event/definitions/action"
|
10197
|
-
},
|
10198
|
-
"actor": {
|
10199
|
-
"$ref": "#/definitions/event/definitions/actor"
|
10200
|
+
"$ref": "#/definitions/enterprise-account/definitions/id"
|
10200
10201
|
},
|
10201
|
-
"
|
10202
|
-
"$ref": "#/definitions/
|
10202
|
+
"created_at": {
|
10203
|
+
"$ref": "#/definitions/enterprise-account/definitions/created_at"
|
10203
10204
|
},
|
10204
|
-
"
|
10205
|
-
"$ref": "#/definitions/
|
10205
|
+
"name": {
|
10206
|
+
"$ref": "#/definitions/enterprise-account/definitions/name"
|
10206
10207
|
},
|
10207
|
-
"
|
10208
|
-
"$ref": "#/definitions/
|
10208
|
+
"updated_at": {
|
10209
|
+
"$ref": "#/definitions/enterprise-account/definitions/updated_at"
|
10209
10210
|
},
|
10210
|
-
"
|
10211
|
-
"$ref": "#/definitions/
|
10211
|
+
"permissions": {
|
10212
|
+
"$ref": "#/definitions/enterprise-account/definitions/permissions"
|
10212
10213
|
},
|
10213
|
-
"
|
10214
|
-
"$ref": "#/definitions/
|
10214
|
+
"trial": {
|
10215
|
+
"$ref": "#/definitions/enterprise-account/definitions/trial"
|
10215
10216
|
},
|
10216
|
-
"
|
10217
|
-
"
|
10217
|
+
"identity_provider": {
|
10218
|
+
"description": "Identity Provider associated with the Enterprise Account",
|
10219
|
+
"strictProperties": true,
|
10220
|
+
"type": [
|
10221
|
+
"null",
|
10222
|
+
"object"
|
10223
|
+
],
|
10224
|
+
"properties": {
|
10225
|
+
"id": {
|
10226
|
+
"$ref": "#/definitions/identity-provider/definitions/id"
|
10227
|
+
},
|
10228
|
+
"name": {
|
10229
|
+
"description": "user-friendly unique identifier for this identity provider",
|
10230
|
+
"example": "acme-sso",
|
10231
|
+
"type": [
|
10232
|
+
"string"
|
10233
|
+
]
|
10234
|
+
},
|
10235
|
+
"owner": {
|
10236
|
+
"$ref": "#/definitions/identity-provider/definitions/owner"
|
10237
|
+
}
|
10238
|
+
}
|
10218
10239
|
}
|
10219
10240
|
}
|
10220
10241
|
},
|
@@ -15078,7 +15099,7 @@ module PlatformAPI
|
|
15078
15099
|
]
|
15079
15100
|
},
|
15080
15101
|
"pr_number": {
|
15081
|
-
"description": "
|
15102
|
+
"description": "pull request number the review app is built for",
|
15082
15103
|
"example": 24,
|
15083
15104
|
"readOnly": true,
|
15084
15105
|
"type": [
|
@@ -15098,6 +15119,9 @@ module PlatformAPI
|
|
15098
15119
|
"branch": {
|
15099
15120
|
"$ref": "#/definitions/review-app/definitions/branch"
|
15100
15121
|
},
|
15122
|
+
"pr_number": {
|
15123
|
+
"$ref": "#/definitions/review-app/definitions/pr_number"
|
15124
|
+
},
|
15101
15125
|
"pipeline": {
|
15102
15126
|
"$ref": "#/definitions/pipeline/definitions/id"
|
15103
15127
|
},
|
@@ -16326,6 +16350,137 @@ module PlatformAPI
|
|
16326
16350
|
}
|
16327
16351
|
}
|
16328
16352
|
},
|
16353
|
+
"space-topology": {
|
16354
|
+
"description": "Space Topology provides you with a mechanism for viewing all the running dynos, formations and applications for a space. This is the same data thats used to power our DNS Service Discovery.",
|
16355
|
+
"$schema": "http://json-schema.org/draft-04/hyper-schema",
|
16356
|
+
"stability": "prototype",
|
16357
|
+
"strictProperties": true,
|
16358
|
+
"title": "Heroku Platform API - Space Topology",
|
16359
|
+
"type": [
|
16360
|
+
"object"
|
16361
|
+
],
|
16362
|
+
"definitions": {
|
16363
|
+
"version": {
|
16364
|
+
"description": "version of the space topology payload",
|
16365
|
+
"example": 1,
|
16366
|
+
"readOnly": true,
|
16367
|
+
"type": [
|
16368
|
+
"integer"
|
16369
|
+
]
|
16370
|
+
},
|
16371
|
+
"dyno": {
|
16372
|
+
"description": "A dyno",
|
16373
|
+
"properties": {
|
16374
|
+
"id": {
|
16375
|
+
"$ref": "#/definitions/dyno/definitions/id"
|
16376
|
+
},
|
16377
|
+
"number": {
|
16378
|
+
"description": "process number, e.g. 1 in web.1",
|
16379
|
+
"example": 1,
|
16380
|
+
"type": [
|
16381
|
+
"integer"
|
16382
|
+
]
|
16383
|
+
},
|
16384
|
+
"private_ip": {
|
16385
|
+
"description": "RFC1918 Address of Dyno",
|
16386
|
+
"example": "10.0.134.42",
|
16387
|
+
"type": [
|
16388
|
+
"string"
|
16389
|
+
]
|
16390
|
+
},
|
16391
|
+
"hostname": {
|
16392
|
+
"description": "localspace hostname of resource",
|
16393
|
+
"example": "1.example-app-90210.app.localspace",
|
16394
|
+
"type": [
|
16395
|
+
"string"
|
16396
|
+
]
|
16397
|
+
}
|
16398
|
+
}
|
16399
|
+
},
|
16400
|
+
"formation": {
|
16401
|
+
"description": "formations for application",
|
16402
|
+
"properties": {
|
16403
|
+
"id": {
|
16404
|
+
"$ref": "#/definitions/formation/definitions/id"
|
16405
|
+
},
|
16406
|
+
"process_type": {
|
16407
|
+
"description": "Name of process type",
|
16408
|
+
"example": "web",
|
16409
|
+
"type": [
|
16410
|
+
"string"
|
16411
|
+
]
|
16412
|
+
},
|
16413
|
+
"dynos": {
|
16414
|
+
"description": "Current dynos for application",
|
16415
|
+
"items": {
|
16416
|
+
"$ref": "#/definitions/space-topology/definitions/dyno"
|
16417
|
+
},
|
16418
|
+
"type": [
|
16419
|
+
"array"
|
16420
|
+
]
|
16421
|
+
}
|
16422
|
+
},
|
16423
|
+
"type": [
|
16424
|
+
"object"
|
16425
|
+
]
|
16426
|
+
}
|
16427
|
+
},
|
16428
|
+
"links": [
|
16429
|
+
{
|
16430
|
+
"description": "Current space topology",
|
16431
|
+
"href": "/spaces/{(%23%2Fdefinitions%2Fspace%2Fdefinitions%2Fidentity)}/topology",
|
16432
|
+
"method": "GET",
|
16433
|
+
"rel": "self",
|
16434
|
+
"targetSchema": {
|
16435
|
+
"$ref": "#/definitions/space-topology"
|
16436
|
+
},
|
16437
|
+
"title": "Topology"
|
16438
|
+
}
|
16439
|
+
],
|
16440
|
+
"properties": {
|
16441
|
+
"version": {
|
16442
|
+
"$ref": "#/definitions/space-topology/definitions/version"
|
16443
|
+
},
|
16444
|
+
"apps": {
|
16445
|
+
"description": "The apps within this space",
|
16446
|
+
"type": [
|
16447
|
+
"array"
|
16448
|
+
],
|
16449
|
+
"readOnly": true,
|
16450
|
+
"items": {
|
16451
|
+
"type": [
|
16452
|
+
"object"
|
16453
|
+
],
|
16454
|
+
"properties": {
|
16455
|
+
"id": {
|
16456
|
+
"$ref": "#/definitions/app/definitions/id",
|
16457
|
+
"readOnly": true
|
16458
|
+
},
|
16459
|
+
"domains": {
|
16460
|
+
"example": [
|
16461
|
+
"example.com",
|
16462
|
+
"example.net"
|
16463
|
+
],
|
16464
|
+
"readOnly": true,
|
16465
|
+
"type": [
|
16466
|
+
"array"
|
16467
|
+
]
|
16468
|
+
},
|
16469
|
+
"formation": {
|
16470
|
+
"description": "formations for application",
|
16471
|
+
"items": {
|
16472
|
+
"$ref": "#/definitions/space-topology/definitions/formation"
|
16473
|
+
},
|
16474
|
+
"type": [
|
16475
|
+
"array"
|
16476
|
+
],
|
16477
|
+
"readOnly": true
|
16478
|
+
}
|
16479
|
+
}
|
16480
|
+
}
|
16481
|
+
}
|
16482
|
+
}
|
16483
|
+
},
|
16329
16484
|
"space-transfer": {
|
16330
16485
|
"description": "Transfer spaces between enterprise teams with the same Enterprise Account.",
|
16331
16486
|
"$schema": "http://json-schema.org/draft-04/hyper-schema",
|
@@ -20631,6 +20786,9 @@ module PlatformAPI
|
|
20631
20786
|
"archive": {
|
20632
20787
|
"$ref": "#/definitions/archive"
|
20633
20788
|
},
|
20789
|
+
"audit-trail-event": {
|
20790
|
+
"$ref": "#/definitions/audit-trail-event"
|
20791
|
+
},
|
20634
20792
|
"build": {
|
20635
20793
|
"$ref": "#/definitions/build"
|
20636
20794
|
},
|
@@ -20667,9 +20825,6 @@ module PlatformAPI
|
|
20667
20825
|
"enterprise-account": {
|
20668
20826
|
"$ref": "#/definitions/enterprise-account"
|
20669
20827
|
},
|
20670
|
-
"event": {
|
20671
|
-
"$ref": "#/definitions/event"
|
20672
|
-
},
|
20673
20828
|
"filter-apps": {
|
20674
20829
|
"$ref": "#/definitions/filter-apps"
|
20675
20830
|
},
|
@@ -20790,6 +20945,9 @@ module PlatformAPI
|
|
20790
20945
|
"space-nat": {
|
20791
20946
|
"$ref": "#/definitions/space-nat"
|
20792
20947
|
},
|
20948
|
+
"space-topology": {
|
20949
|
+
"$ref": "#/definitions/space-topology"
|
20950
|
+
},
|
20793
20951
|
"space-transfer": {
|
20794
20952
|
"$ref": "#/definitions/space-transfer"
|
20795
20953
|
},
|