schema.json in platform-api-3.2.0 vs schema.json in platform-api-3.3.0
- old
+ new
@@ -226,10 +226,19 @@
"readOnly": true,
"type": [
"string"
]
},
+ "country_of_residence": {
+ "description": "country where account owner resides",
+ "example": "United States",
+ "readOnly": false,
+ "type": [
+ "string",
+ "null"
+ ]
+ },
"email": {
"description": "unique email address of account",
"example": "username@example.com",
"format": "email",
"readOnly": false,
@@ -359,38 +368,42 @@
"type": [
"boolean"
]
},
"acknowledged_msa": {
- "description": "whether account has acknowledged the MSA terms of service",
+ "deprecated": true,
+ "description": "deprecated. whether account has acknowledged the MSA terms of service",
"example": false,
"readOnly": true,
"type": [
"boolean"
]
},
"acknowledged_msa_at": {
- "description": "when account has acknowledged the MSA terms of service",
+ "deprecated": true,
+ "description": "deprecated. when account has acknowledged the MSA terms of service",
"example": "2012-01-01T12:00:00Z",
"format": "date-time",
"readOnly": true,
"type": [
"string",
"null"
]
},
"italian_customer_terms": {
- "description": "whether account has acknowledged the Italian customer terms of service",
+ "deprecated": true,
+ "description": "deprecated. whether account has acknowledged the Italian customer terms of service",
"example": "affirmatively_accepted",
"readOnly": true,
"type": [
"string",
"null"
]
},
"italian_partner_terms": {
- "description": "whether account has acknowledged the Italian provider terms of service",
+ "deprecated": true,
+ "description": "deprecated. whether account has acknowledged the Italian provider terms of service",
"example": "affirmatively_accepted",
"readOnly": true,
"type": [
"string",
"null"
@@ -618,10 +631,13 @@
"$ref": "#/definitions/account/definitions/italian_customer_terms"
},
"italian_partner_terms": {
"$ref": "#/definitions/account/definitions/italian_partner_terms"
},
+ "country_of_residence": {
+ "$ref": "#/definitions/account/definitions/country_of_residence"
+ },
"default_organization": {
"description": "team selected by default",
"properties": {
"id": {
"$ref": "#/definitions/team/definitions/id"
@@ -4244,16 +4260,28 @@
"identity": {
"$ref": "#/definitions/archive/definitions/id"
},
"month": {
"description": "month of the archive",
- "example": 10,
+ "enum": [
+ "01",
+ "02",
+ "03",
+ "04",
+ "05",
+ "06",
+ "07",
+ "08",
+ "09",
+ "10",
+ "11",
+ "12"
+ ],
+ "example": "10",
"readOnly": true,
- "minimum": 1,
- "maximum": 12,
"type": [
- "integer"
+ "string"
]
},
"year": {
"description": "year of the archive",
"example": 2019,
@@ -4346,17 +4374,10 @@
"format": "uuid",
"type": [
"string"
]
},
- "identity": {
- "anyOf": [
- {
- "$ref": "#/definitions/audit-trail-event/definitions/id"
- }
- ]
- },
"type": {
"description": "type of event",
"readOnly": true,
"type": [
"string"
@@ -4501,11 +4522,11 @@
]
}
},
"links": [
{
- "description": "List existing events.",
+ "description": "List existing events. Returns all events for one date, defaulting to current date. Order, actor, action, and type, and date query params can be specified as query parameters. For example, '/enterprise-accounts/:id/events?order=desc&actor=user@example.com&action=create&type=app&date=2020-09-30' would return events in descending order and only return app created events by the user with user@example.com email address.",
"href": "/enterprise-accounts/{(%23%2Fdefinitions%2Fenterprise-account%2Fdefinitions%2Fidentity)}/events",
"method": "GET",
"rel": "instances",
"title": "List"
}
@@ -6486,12 +6507,12 @@
"links": [
{
"description": "Retrieves usage for an enterprise account for a range of days. Start and end dates can be specified as query parameters using the date format, YYYY-MM-DD format. For example, '/enterprise-accounts/example-account/usage/daily?start=2019-01-01&end=2019-01-31' specifies all days in January for 2019.",
"href": "/enterprise-accounts/{(%23%2Fdefinitions%2Fenterprise-account%2Fdefinitions%2Fid)}/usage/daily",
"method": "GET",
- "title": "Info",
"rel": "instances",
+ "title": "Info",
"targetSchema": {
"items": {
"$ref": "#/definitions/enterprise-account-usage-daily"
},
"type": [
@@ -12535,11 +12556,12 @@
"cname": {
"description": "deprecated; refer to GET /apps/:id/domains for valid CNAMEs for this app",
"example": "example.herokussl.com",
"readOnly": false,
"type": [
- "string"
+ "string",
+ "null"
]
},
"created_at": {
"description": "when endpoint was created",
"example": "2012-01-01T12:00:00Z",
@@ -12591,10 +12613,30 @@
"format": "date-time",
"readOnly": true,
"type": [
"string"
]
+ },
+ "domains": {
+ "description": "domains associated with this SSL certificate",
+ "type": [
+ "array"
+ ],
+ "readOnly": true,
+ "items": {
+ "$ref": "#/definitions/domain/definitions/id"
+ }
+ },
+ "display_name": {
+ "description": "unique name for SSL certificate",
+ "example": "example",
+ "pattern": "^[a-z][a-z0-9-]{2,29}$",
+ "readOnly": false,
+ "type": [
+ "string",
+ "null"
+ ]
}
},
"links": [
{
"description": "Create a new SNI endpoint.",
@@ -12702,10 +12744,69 @@
"name": {
"$ref": "#/definitions/sni-endpoint/definitions/name"
},
"updated_at": {
"$ref": "#/definitions/sni-endpoint/definitions/updated_at"
+ },
+ "display_name": {
+ "$ref": "#/definitions/sni-endpoint/definitions/display_name"
+ },
+ "domains": {
+ "$ref": "#/definitions/sni-endpoint/definitions/domains"
+ },
+ "app": {
+ "description": "application that this SSL certificate is on",
+ "properties": {
+ "id": {
+ "$ref": "#/definitions/app/definitions/id"
+ },
+ "name": {
+ "$ref": "#/definitions/app/definitions/name"
+ }
+ },
+ "strictProperties": true,
+ "type": [
+ "object"
+ ]
+ },
+ "ssl_cert": {
+ "description": "certificate provided by this endpoint",
+ "type": [
+ "object"
+ ],
+ "properties": {
+ "ca_signed?": {
+ "$ref": "#/definitions/ssl-endpoint/definitions/ca_signed?"
+ },
+ "cert_domains": {
+ "$ref": "#/definitions/ssl-endpoint/definitions/cert_domains"
+ },
+ "expires_at": {
+ "$ref": "#/definitions/ssl-endpoint/definitions/expires_at"
+ },
+ "issuer": {
+ "$ref": "#/definitions/ssl-endpoint/definitions/issuer"
+ },
+ "self_signed?": {
+ "$ref": "#/definitions/ssl-endpoint/definitions/self_signed?"
+ },
+ "starts_at": {
+ "$ref": "#/definitions/ssl-endpoint/definitions/starts_at"
+ },
+ "subject": {
+ "$ref": "#/definitions/ssl-endpoint/definitions/subject"
+ },
+ "id": {
+ "description": "unique identifier of this SSL certificate",
+ "example": "01234567-89ab-cdef-0123-456789abcdef",
+ "format": "uuid",
+ "readOnly": true,
+ "type": [
+ "string"
+ ]
+ }
+ }
}
}
},
"source": {
"description": "A source is a location for uploading and downloading an application's source code.",
@@ -13502,11 +13603,12 @@
"description": "unique name for SSL endpoint",
"example": "example",
"pattern": "^[a-z][a-z0-9-]{2,29}$",
"readOnly": false,
"type": [
- "string"
+ "string",
+ "null"
]
},
"expires_at": {
"readOnly": true,
"format": "date-time",
@@ -15372,11 +15474,12 @@
},
"identity": {
"$ref": "#/definitions/team/definitions/identity"
},
"whitelisting-enabled": {
- "description": "Whether whitelisting rules should be applied to add-on installations",
+ "deactivate_on": "2021-02-05",
+ "description": "Whether whitelisting rules should be applied to add-on installations. Deprecated in favor of `addons-controls`",
"example": true,
"readOnly": false,
"type": [
"boolean",
"null"
@@ -15566,11 +15669,11 @@
]
}
},
"links": [
{
- "description": "Retrieves usage for an enterprise team for a range of days. Start and end dates can be specified as query parameters using the date format, YYYY-MM-DD format. For example, '/teams/example-team/usage?start=2019-01-01&end=2019-01-31' specifies all days in January for 2019.",
+ "description": "Retrieves usage for an enterprise team for a range of days. Start and end dates can be specified as query parameters using the date format, YYYY-MM-DD format. For example, '/teams/example-team/usage/daily?start=2019-01-01&end=2019-01-31' specifies all days in January for 2019.",
"href": "/teams/{(%23%2Fdefinitions%2Fteam%2Fdefinitions%2Fid)}/usage/daily",
"method": "GET",
"title": "Info",
"rel": "instances",
"targetSchema": {
@@ -15727,15 +15830,15 @@
]
}
},
"links": [
{
- "description": "Retrieves usage for an enterprise team for a range of months. Start and end dates can be specified as query parameters using the date format, YYYY-MM format. For example, '/teams/example-team/usage?start=2019-01&end=2019-02' specifies usage in January and February for 2019. If no end date is specified, one month of usage is returned.",
+ "description": "Retrieves usage for an enterprise team for a range of months. Start and end dates can be specified as query parameters using the date format, YYYY-MM format. For example, '/teams/example-team/usage/monthly?start=2019-01&end=2019-02' specifies usage in January and February for 2019. If no end date is specified, one month of usage is returned.",
"href": "/teams/{(%23%2Fdefinitions%2Fteam%2Fdefinitions%2Fid)}/usage/monthly",
"method": "GET",
- "rel": "instances",
"title": "Info",
+ "rel": "instances",
"targetSchema": {
"items": {
"$ref": "#/definitions/team-usage-monthly"
},
"type": [
@@ -17359,15 +17462,38 @@
"rel": "self",
"targetSchema": {
"$ref": "#/definitions/vpn-connection"
},
"title": "Info"
+ },
+ {
+ "description": "Update a VPN connection in a private space.",
+ "href": "/spaces/{(%23%2Fdefinitions%2Fspace%2Fdefinitions%2Fidentity)}/vpn-connections/{(%23%2Fdefinitions%2Fvpn-connection%2Fdefinitions%2Fidentity)}",
+ "rel": "update",
+ "schema": {
+ "properties": {
+ "routable_cidrs": {
+ "$ref": "#/definitions/vpn-connection/definitions/routable_cidrs"
+ }
+ },
+ "required": [
+ "routable_cidrs"
+ ],
+ "type": [
+ "object"
+ ]
+ },
+ "targetSchema": {
+ "$ref": "#/definitions/vpn-connection"
+ },
+ "method": "PATCH",
+ "title": "Update"
}
]
},
"whitelisted-add-on-service": {
- "description": "Entities that have been whitelisted to be used by an Team",
+ "description": "Entities that have been whitelisted to be used by a Team. Deprecated in favor of [Allowed Add-on Service](#allowed-add-on-service) endpoints.",
"$schema": "http://json-schema.org/draft-04/hyper-schema",
"stability": "prototype",
"strictProperties": true,
"title": "Heroku Platform API - Whitelisted Entity",
"type": [
@@ -17444,11 +17570,12 @@
]
}
},
"links": [
{
- "description": "List all whitelisted Add-on Services for an Team",
+ "deactivate_on": "2021-02-05",
+ "description": "List all whitelisted Add-on Services for a Team - Deprecated in favor of [`GET /teams/{team_name_or_id}/allowed-addon-services`](#allowed-add-on-service-list-by-team) endpoint.",
"href": "/teams/{(%23%2Fdefinitions%2Fteam%2Fdefinitions%2Fidentity)}/whitelisted-addon-services",
"method": "GET",
"rel": "instances",
"targetSchema": {
"items": {
@@ -17456,14 +17583,15 @@
},
"type": [
"array"
]
},
- "title": "List By Team"
+ "title": "List By Team - Deprecated"
},
{
- "description": "Whitelist an Add-on Service",
+ "deactivate_on": "2021-02-05",
+ "description": "Whitelist an Add-on Service - Deprecated in favor of [`POST /teams/{team_name_or_id}/allowed-addon-services`](#allowed-add-on-service-create-by-team) endpoint.",
"href": "/teams/{(%23%2Fdefinitions%2Fteam%2Fdefinitions%2Fidentity)}/whitelisted-addon-services",
"method": "POST",
"rel": "create",
"schema": {
"type": [
@@ -17485,20 +17613,21 @@
},
"type": [
"array"
]
},
- "title": "Create By Team"
+ "title": "Create By Team - Deprecated"
},
{
- "description": "Remove a whitelisted entity",
+ "deactivate_on": "2021-02-05",
+ "description": "Remove a whitelisted entity - Deprecated in favor of [`DELETE /teams/{team_name_or_id}/allowed-addon-services/{allowed_add_on_service_id_or_name}`](#allowed-add-on-service-delete-by-team) endpoint.",
"href": "/teams/{(%23%2Fdefinitions%2Fteam%2Fdefinitions%2Fidentity)}/whitelisted-addon-services/{(%23%2Fdefinitions%2Fwhitelisted-add-on-service%2Fdefinitions%2Fidentity)}",
"method": "DELETE",
"rel": "destroy",
"targetSchema": {
"$ref": "#/definitions/whitelisted-add-on-service"
},
- "title": "Delete By Team"
+ "title": "Delete By Team - Deprecated"
}
],
"properties": {
"added_at": {
"$ref": "#/definitions/whitelisted-add-on-service/definitions/added_at"