Skip to content

Commit 335fa31

Browse files
heroku-cliheroku-cli
committed
fix: updated schema
1 parent 54dd110 commit 335fa31

File tree

2 files changed

+325
-1
lines changed

2 files changed

+325
-1
lines changed

‎lib/index.d.ts

Lines changed: 97 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -61,6 +61,8 @@ export interface HerokuPlatformApi {
6161
organization?: Organization
6262
'outbound-ruleset'?: OutboundRuleset
6363
'password-reset'?: PasswordReset
64+
'peering-info'?: PeeringInfo
65+
peering?: Peering
6466
'organization-app-permission'?: OrganizationAppPermission
6567
'pipeline-coupling'?: PipelineCoupling
6668
'pipeline-promotion-target'?: PipelinePromotionTarget
@@ -430,7 +432,18 @@ export interface Region {
430432
/**
431433
* region name used by provider
432434
*/
433-
region?: string
435+
region?:
436+
| 'ap-south-1'
437+
| 'eu-west-1'
438+
| 'ap-southeast-1'
439+
| 'ap-southeast-2'
440+
| 'eu-central-1'
441+
| 'ap-northeast-2'
442+
| 'ap-northeast-1'
443+
| 'us-east-1'
444+
| 'sa-east-1'
445+
| 'us-west-1'
446+
| 'us-west-2'
434447
[k: string]: any
435448
}
436449
/**
@@ -2540,6 +2553,89 @@ export interface PasswordReset {
25402553
}
25412554
[k: string]: any
25422555
}
2556+
/**
2557+
* [Peering Info](https://devcenter.heroku.com/articles/private-space-vpc-peering) gives you the information necessary to peer an AWS VPC to a Private Space.
2558+
*/
2559+
export interface PeeringInfo {
2560+
/**
2561+
* The AWS account ID of your Private Space.
2562+
*/
2563+
aws_account_id?: string
2564+
/**
2565+
* region name used by provider
2566+
*/
2567+
aws_region?:
2568+
| 'ap-south-1'
2569+
| 'eu-west-1'
2570+
| 'ap-southeast-1'
2571+
| 'ap-southeast-2'
2572+
| 'eu-central-1'
2573+
| 'ap-northeast-2'
2574+
| 'ap-northeast-1'
2575+
| 'us-east-1'
2576+
| 'sa-east-1'
2577+
| 'us-west-1'
2578+
| 'us-west-2'
2579+
/**
2580+
* The AWS VPC ID of the peer.
2581+
*/
2582+
vpc_id?: string
2583+
/**
2584+
* The CIDR range of the Private Space VPC
2585+
*/
2586+
vpc_cidr?: string
2587+
/**
2588+
* The CIDR ranges that should be routed to the Private Space VPC.
2589+
*/
2590+
dyno_cidr_blocks?: string[]
2591+
/**
2592+
* The CIDR ranges that you must not conflict with.
2593+
*/
2594+
unavailable_cidr_blocks?: string[]
2595+
[k: string]: any
2596+
}
2597+
/**
2598+
* [Peering](https://devcenter.heroku.com/articles/private-space-vpc-peering) provides a way to peer your Private Space VPC to another AWS VPC.
2599+
*/
2600+
export interface Peering {
2601+
/**
2602+
* The type of peering connection.
2603+
*/
2604+
type?: 'heroku-managed' | 'customer-managed' | 'unknown'
2605+
/**
2606+
* The AWS VPC Peering Connection ID of the peering.
2607+
*/
2608+
pcx_id?: string
2609+
/**
2610+
* The CIDR blocks of the peer.
2611+
*/
2612+
cidr_blocks?: string[]
2613+
/**
2614+
* The status of the peering connection.
2615+
*/
2616+
status?:
2617+
| 'initiating-request'
2618+
| 'pending-acceptance'
2619+
| 'provisioning'
2620+
| 'active'
2621+
| 'failed'
2622+
| 'expired'
2623+
| 'rejected'
2624+
| 'deleted'
2625+
/**
2626+
* The AWS VPC ID of the peer.
2627+
*/
2628+
aws_vpc_id?: string
2629+
/**
2630+
* The AWS account ID of your Private Space.
2631+
*/
2632+
aws_account_id?: string
2633+
/**
2634+
* When a peering connection will expire.
2635+
*/
2636+
expires?: string
2637+
[k: string]: any
2638+
}
25432639
/**
25442640
* Deprecated: An organization app permission is a behavior that is assigned to a user in an organization app.
25452641
*/

‎schema.json

Lines changed: 228 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9824,6 +9824,215 @@
98249824
}
98259825
}
98269826
},
9827+
"peering-info": {
9828+
"description": "[Peering Info](https://devcenter.heroku.com/articles/private-space-vpc-peering) gives you the information necessary to peer an AWS VPC to a Private Space.",
9829+
"$schema": "http://json-schema.org/draft-04/hyper-schema",
9830+
"stability": "prototype",
9831+
"strictProperties": true,
9832+
"title": "Heroku Platform API - Peering Info",
9833+
"type": [
9834+
"object"
9835+
],
9836+
"properties": {
9837+
"aws_account_id": {
9838+
"$ref": "#/definitions/peering/definitions/aws_account_id"
9839+
},
9840+
"aws_region": {
9841+
"$ref": "#/definitions/region/definitions/provider/properties/region"
9842+
},
9843+
"vpc_id": {
9844+
"$ref": "#/definitions/peering/definitions/vpc_id"
9845+
},
9846+
"vpc_cidr": {
9847+
"description": "The CIDR range of the Private Space VPC",
9848+
"$ref": "#/definitions/peering/definitions/cidr"
9849+
},
9850+
"dyno_cidr_blocks": {
9851+
"description": "The CIDR ranges that should be routed to the Private Space VPC.",
9852+
"type": [
9853+
"array"
9854+
],
9855+
"items": {
9856+
"$ref": "#/definitions/peering/definitions/cidr"
9857+
}
9858+
},
9859+
"unavailable_cidr_blocks": {
9860+
"description": "The CIDR ranges that you must not conflict with.",
9861+
"type": [
9862+
"array"
9863+
],
9864+
"items": {
9865+
"$ref": "#/definitions/peering/definitions/cidr"
9866+
}
9867+
}
9868+
},
9869+
"links": [
9870+
{
9871+
"description": "Provides the necessary information to establish an AWS VPC Peering with your private space.",
9872+
"href": "/spaces/{(%23%2Fdefinitions%2Fspace%2Fdefinitions%2Fidentity)}/peering-info",
9873+
"method": "GET",
9874+
"rel": {
9875+
"$ref": "#/definitions/peering-info"
9876+
},
9877+
"targetSchema": {
9878+
"$ref": "#/definitions/peering-info"
9879+
},
9880+
"title": "Info"
9881+
}
9882+
]
9883+
},
9884+
"peering": {
9885+
"description": "[Peering](https://devcenter.heroku.com/articles/private-space-vpc-peering) provides a way to peer your Private Space VPC to another AWS VPC.",
9886+
"$schema": "http://json-schema.org/draft-04/hyper-schema",
9887+
"stability": "prototype",
9888+
"strictProperties": true,
9889+
"title": "Heroku Platform API - Peering",
9890+
"type": [
9891+
"object"
9892+
],
9893+
"definitions": {
9894+
"aws_account_id": {
9895+
"description": "The AWS account ID of your Private Space.",
9896+
"example": "123456789012",
9897+
"readOnly": true,
9898+
"type": [
9899+
"string"
9900+
]
9901+
},
9902+
"vpc_id": {
9903+
"description": "The AWS VPC ID of the peer.",
9904+
"example": "vpc-1234567890",
9905+
"readOnly": true,
9906+
"type": [
9907+
"string"
9908+
]
9909+
},
9910+
"type": {
9911+
"description": "The type of peering connection.",
9912+
"example": "heroku-managed",
9913+
"type": [
9914+
"string"
9915+
],
9916+
"enum": [
9917+
"heroku-managed",
9918+
"customer-managed",
9919+
"unknown"
9920+
]
9921+
},
9922+
"status": {
9923+
"description": "The status of the peering connection.",
9924+
"example": "pending-acceptance",
9925+
"enum": [
9926+
"initiating-request",
9927+
"pending-acceptance",
9928+
"provisioning",
9929+
"active",
9930+
"failed",
9931+
"expired",
9932+
"rejected",
9933+
"deleted"
9934+
],
9935+
"type": [
9936+
"string"
9937+
],
9938+
"readOnly": true
9939+
},
9940+
"pcx_id": {
9941+
"description": "The AWS VPC Peering Connection ID of the peering.",
9942+
"example": "pcx-123456789012",
9943+
"readOnly": true,
9944+
"type": [
9945+
"string"
9946+
]
9947+
},
9948+
"cidr": {
9949+
"description": "An IP address and the number of significant bits that make up the routing or networking portion.",
9950+
"example": "10.0.0.0/16",
9951+
"type": [
9952+
"string"
9953+
]
9954+
},
9955+
"expires": {
9956+
"description": "When a peering connection will expire.",
9957+
"example": "2020-01-01T12:00:00Z",
9958+
"format": "date-time",
9959+
"readOnly": true,
9960+
"type": [
9961+
"string"
9962+
]
9963+
}
9964+
},
9965+
"properties": {
9966+
"type": {
9967+
"$ref": "#/definitions/peering/definitions/type"
9968+
},
9969+
"pcx_id": {
9970+
"$ref": "#/definitions/peering/definitions/pcx_id"
9971+
},
9972+
"cidr_blocks": {
9973+
"description": "The CIDR blocks of the peer.",
9974+
"type": [
9975+
"array"
9976+
],
9977+
"items": {
9978+
"$ref": "#/definitions/peering/definitions/cidr"
9979+
}
9980+
},
9981+
"status": {
9982+
"$ref": "#/definitions/peering/definitions/status"
9983+
},
9984+
"aws_vpc_id": {
9985+
"$ref": "#/definitions/peering/definitions/vpc_id"
9986+
},
9987+
"aws_account_id": {
9988+
"$ref": "#/definitions/peering/definitions/aws_account_id"
9989+
},
9990+
"expires": {
9991+
"$ref": "#/definitions/peering/definitions/expires"
9992+
}
9993+
},
9994+
"links": [
9995+
{
9996+
"description": "List peering connections of a private space.",
9997+
"href": "/spaces/{(%23%2Fdefinitions%2Fspace%2Fdefinitions%2Fidentity)}/peerings",
9998+
"method": "GET",
9999+
"rel": "instances",
10000+
"targetSchema": {
10001+
"items": {
10002+
"$ref": "#/definitions/peering"
10003+
},
10004+
"type": [
10005+
"array"
10006+
]
10007+
},
10008+
"title": "List"
10009+
},
10010+
{
10011+
"description": "Accept a pending peering connection with a private space.",
10012+
"href": "/spaces/{(%23%2Fdefinitions%2Fspace%2Fdefinitions%2Fidentity)}/peerings/{(%23%2Fdefinitions%2Fpeering%2Fdefinitions%2Fpcx_id)}/actions/accept",
10013+
"method": "POST",
10014+
"rel": "empty",
10015+
"title": "Accept"
10016+
},
10017+
{
10018+
"description": "Destroy an active peering connection with a private space.",
10019+
"href": "/spaces/{(%23%2Fdefinitions%2Fspace%2Fdefinitions%2Fidentity)}/peerings/{(%23%2Fdefinitions%2Fpeering%2Fdefinitions%2Fpcx_id)}",
10020+
"rel": "empty",
10021+
"method": "DELETE",
10022+
"title": "Destroy"
10023+
},
10024+
{
10025+
"description": "Fetch information for existing peering connection",
10026+
"href": "/spaces/{(%23%2Fdefinitions%2Fspace%2Fdefinitions%2Fidentity)}/peerings/{(%23%2Fdefinitions%2Fpeering%2Fdefinitions%2Fpcx_id)}",
10027+
"method": "GET",
10028+
"rel": "self",
10029+
"targetSchema": {
10030+
"$ref": "#/definitions/peering"
10031+
},
10032+
"title": "Info"
10033+
}
10034+
]
10035+
},
982710036
"organization-app-permission": {
982810037
"$schema": "http://json-schema.org/draft-04/hyper-schema",
982910038
"description": "Deprecated: An organization app permission is a behavior that is assigned to a user in an organization app.",
@@ -10969,6 +11178,19 @@
1096911178
"readOnly": true,
1097011179
"type": [
1097111180
"string"
11181+
],
11182+
"enum": [
11183+
"ap-south-1",
11184+
"eu-west-1",
11185+
"ap-southeast-1",
11186+
"ap-southeast-2",
11187+
"eu-central-1",
11188+
"ap-northeast-2",
11189+
"ap-northeast-1",
11190+
"us-east-1",
11191+
"sa-east-1",
11192+
"us-west-1",
11193+
"us-west-2"
1097211194
]
1097311195
}
1097411196
},
@@ -15046,6 +15268,12 @@
1504615268
"password-reset": {
1504715269
"$ref": "#/definitions/password-reset"
1504815270
},
15271+
"peering-info": {
15272+
"$ref": "#/definitions/peering-info"
15273+
},
15274+
"peering": {
15275+
"$ref": "#/definitions/peering"
15276+
},
1504915277
"organization-app-permission": {
1505015278
"$ref": "#/definitions/organization-app-permission"
1505115279
},

0 commit comments

Comments
 (0)