Skip to content

Commit 204a354

Browse files
heroku-cliheroku-cli
committed
fix: updated schema
1 parent ef330d4 commit 204a354

2 files changed

Lines changed: 232 additions & 0 deletions

File tree

‎lib/index.d.ts‎

Lines changed: 66 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -91,6 +91,7 @@ export interface HerokuPlatformApi {
9191
'team-preferences'?: TeamPreferences
9292
team?: Team
9393
'user-preferences'?: UserPreferences
94+
'vpn-connection'?: PrivateSpacesVpn
9495
'whitelisted-add-on-service'?: WhitelistedEntity
9596
[k: string]: any
9697
}
@@ -3862,6 +3863,71 @@ export interface UserPreferences {
38623863
'dismissed-sms-banner'?: boolean | null
38633864
[k: string]: any
38643865
}
3866+
/**
3867+
* [VPN](https://devcenter.heroku.com/articles/private-spaces-vpn?preview=1) provides a way to connect your Private Spaces to your network via VPN.
3868+
*/
3869+
export interface PrivateSpacesVpn {
3870+
/**
3871+
* VPN ID
3872+
*/
3873+
id?: string
3874+
/**
3875+
* VPN Name
3876+
*/
3877+
name?: string
3878+
/**
3879+
* Public IP of VPN customer gateway
3880+
*/
3881+
public_ip?: string
3882+
/**
3883+
* Routable CIDRs of VPN
3884+
*/
3885+
routable_cidrs?: string[]
3886+
/**
3887+
* CIDR Block of the Private Space
3888+
*/
3889+
space_cidr_block?: string
3890+
tunnels?: {
3891+
/**
3892+
* Timestamp of last status changed
3893+
*/
3894+
last_status_change?: string
3895+
/**
3896+
* Public IP address for the tunnel
3897+
*/
3898+
ip?: string
3899+
/**
3900+
* Public IP address for the customer side of the tunnel
3901+
*/
3902+
customer_ip?: string
3903+
/**
3904+
* Pre-shared key
3905+
*/
3906+
pre_shared_key?: string
3907+
/**
3908+
* Status of the tunnel
3909+
*/
3910+
status?: string
3911+
/**
3912+
* Details of the status
3913+
*/
3914+
status_message?: string
3915+
[k: string]: any
3916+
}[]
3917+
/**
3918+
* IKE Version
3919+
*/
3920+
ike_version?: number
3921+
/**
3922+
* Status of the VPN
3923+
*/
3924+
status?: string
3925+
/**
3926+
* Details of the status
3927+
*/
3928+
status_message?: string
3929+
[k: string]: any
3930+
}
38653931
/**
38663932
* Entities that have been whitelisted to be used by an Organization
38673933
*/

‎schema.json‎

Lines changed: 166 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14936,6 +14936,169 @@
1493614936
}
1493714937
}
1493814938
},
14939+
"vpn-connection": {
14940+
"description": "[VPN](https://devcenter.heroku.com/articles/private-spaces-vpn?preview=1) provides a way to connect your Private Spaces to your network via VPN.",
14941+
"$schema": "http://json-schema.org/draft-04/hyper-schema",
14942+
"stability": "prototype",
14943+
"strictProperties": true,
14944+
"title": "Heroku Platform API - Private Spaces VPN",
14945+
"type": [
14946+
"object"
14947+
],
14948+
"definitions": {
14949+
"name": {
14950+
"description": "VPN Name",
14951+
"example": "office",
14952+
"type": [
14953+
"string"
14954+
]
14955+
},
14956+
"public_ip": {
14957+
"description": "Public IP of VPN customer gateway",
14958+
"example": "35.161.69.30",
14959+
"type": [
14960+
"string"
14961+
]
14962+
},
14963+
"routable_cidrs": {
14964+
"description": "Routable CIDRs of VPN",
14965+
"type": [
14966+
"array"
14967+
],
14968+
"items": {
14969+
"example": "172.16.0.0/16",
14970+
"type": [
14971+
"string"
14972+
]
14973+
}
14974+
},
14975+
"id": {
14976+
"description": "VPN ID",
14977+
"example": "123456789012",
14978+
"readOnly": true,
14979+
"type": [
14980+
"string"
14981+
]
14982+
},
14983+
"space_cidr_block": {
14984+
"description": "CIDR Block of the Private Space",
14985+
"example": "10.0.0.0/16",
14986+
"readOnly": true,
14987+
"type": [
14988+
"string"
14989+
]
14990+
},
14991+
"ike_version": {
14992+
"description": "IKE Version",
14993+
"example": 1,
14994+
"readOnly": true,
14995+
"type": [
14996+
"integer"
14997+
]
14998+
},
14999+
"tunnel": {
15000+
"description": "Tunnel info",
15001+
"readOnly": true,
15002+
"type": [
15003+
"object"
15004+
],
15005+
"properties": {
15006+
"last_status_change": {
15007+
"description": "Timestamp of last status changed",
15008+
"example": "2016-10-25T22:09:05Z",
15009+
"type": [
15010+
"string"
15011+
]
15012+
},
15013+
"ip": {
15014+
"description": "Public IP address for the tunnel",
15015+
"example": "52.44.146.197",
15016+
"type": [
15017+
"string"
15018+
]
15019+
},
15020+
"customer_ip": {
15021+
"description": "Public IP address for the customer side of the tunnel",
15022+
"example": "52.44.146.197",
15023+
"type": [
15024+
"string"
15025+
]
15026+
},
15027+
"pre_shared_key": {
15028+
"description": "Pre-shared key",
15029+
"example": "secret",
15030+
"type": [
15031+
"string"
15032+
]
15033+
},
15034+
"status": {
15035+
"description": "Status of the tunnel",
15036+
"example": "UP",
15037+
"type": [
15038+
"string"
15039+
]
15040+
},
15041+
"status_message": {
15042+
"description": "Details of the status",
15043+
"example": "status message",
15044+
"type": [
15045+
"string"
15046+
]
15047+
}
15048+
}
15049+
},
15050+
"status": {
15051+
"description": "Status of the VPN",
15052+
"example": "active",
15053+
"readOnly": true,
15054+
"type": [
15055+
"string"
15056+
]
15057+
},
15058+
"status_message": {
15059+
"description": "Details of the status",
15060+
"example": "supplied CIDR block already in use",
15061+
"readOnly": true,
15062+
"type": [
15063+
"string"
15064+
]
15065+
}
15066+
},
15067+
"properties": {
15068+
"id": {
15069+
"$ref": "#/definitions/vpn-connection/definitions/id"
15070+
},
15071+
"name": {
15072+
"$ref": "#/definitions/vpn-connection/definitions/name"
15073+
},
15074+
"public_ip": {
15075+
"$ref": "#/definitions/vpn-connection/definitions/public_ip"
15076+
},
15077+
"routable_cidrs": {
15078+
"$ref": "#/definitions/vpn-connection/definitions/routable_cidrs"
15079+
},
15080+
"space_cidr_block": {
15081+
"$ref": "#/definitions/vpn-connection/definitions/space_cidr_block"
15082+
},
15083+
"tunnels": {
15084+
"items": {
15085+
"$ref": "#/definitions/vpn-connection/definitions/tunnel"
15086+
},
15087+
"type": [
15088+
"array"
15089+
]
15090+
},
15091+
"ike_version": {
15092+
"$ref": "#/definitions/vpn-connection/definitions/ike_version"
15093+
},
15094+
"status": {
15095+
"$ref": "#/definitions/vpn-connection/definitions/status"
15096+
},
15097+
"status_message": {
15098+
"$ref": "#/definitions/vpn-connection/definitions/status_message"
15099+
}
15100+
}
15101+
},
1493915102
"whitelisted-add-on-service": {
1494015103
"description": "Entities that have been whitelisted to be used by an Organization",
1494115104
"$schema": "http://json-schema.org/draft-04/hyper-schema",
@@ -15392,6 +15555,9 @@
1539215555
"user-preferences": {
1539315556
"$ref": "#/definitions/user-preferences"
1539415557
},
15558+
"vpn-connection": {
15559+
"$ref": "#/definitions/vpn-connection"
15560+
},
1539515561
"whitelisted-add-on-service": {
1539615562
"$ref": "#/definitions/whitelisted-add-on-service"
1539715563
}

0 commit comments

Comments
 (0)
⚡