platform-api 3.5.0 → 3.7.0

data/schema.json

@@ -4,6 +4,58 @@
     "object"
   ],
   "definitions": {
+    "account-delinquency": {
+      "description": "A Heroku account becomes delinquent due to non-payment. We [suspend and delete](https://help.heroku.com/EREVRILX/what-happens-if-i-have-unpaid-heroku-invoices) delinquent accounts if their invoices remain unpaid.",
+      "$schema": "http://json-schema.org/draft-04/hyper-schema",
+      "stability": "development",
+      "strictProperties": true,
+      "title": "Heroku Platform API - Account Delinquency",
+      "type": [
+        "object"
+      ],
+      "definitions": {
+        "scheduled_suspension_time": {
+          "description": "scheduled time of when we will suspend your account due to delinquency",
+          "example": "2024-01-01T12:00:00Z",
+          "format": "date-time",
+          "readOnly": true,
+          "type": [
+            "string",
+            "null"
+          ]
+        },
+        "scheduled_deletion_time": {
+          "description": "scheduled time of when we will delete your account due to delinquency",
+          "example": "2024-01-01T12:00:00Z",
+          "format": "date-time",
+          "readOnly": true,
+          "type": [
+            "string",
+            "null"
+          ]
+        }
+      },
+      "links": [
+        {
+          "description": "Account delinquency information.",
+          "href": "/account/delinquency",
+          "method": "GET",
+          "rel": "self",
+          "targetSchema": {
+            "$ref": "#/definitions/account-delinquency"
+          },
+          "title": "Info"
+        }
+      ],
+      "properties": {
+        "scheduled_suspension_time": {
+          "$ref": "#/definitions/account-delinquency/definitions/scheduled_suspension_time"
+        },
+        "scheduled_deletion_time": {
+          "$ref": "#/definitions/account-delinquency/definitions/scheduled_deletion_time"
+        }
+      }
+    },
     "account-feature": {
       "description": "An account feature represents a Heroku labs capability that can be enabled or disabled for an account on Heroku.",
       "$schema": "http://json-schema.org/draft-04/hyper-schema",
@@ -599,7 +651,7 @@
           "description": "Mark an add-on as provisioned for use.",
           "href": "/addons/{(%23%2Fdefinitions%2Fadd-on%2Fdefinitions%2Fidentity)}/actions/provision",
           "method": "POST",
-          "rel": "create",
+          "rel": "update",
           "targetSchema": {
             "$ref": "#/definitions/add-on"
           },
@@ -609,7 +661,7 @@
           "description": "Mark an add-on as deprovisioned.",
           "href": "/addons/{(%23%2Fdefinitions%2Fadd-on%2Fdefinitions%2Fidentity)}/actions/deprovision",
           "method": "POST",
-          "rel": "create",
+          "rel": "update",
           "targetSchema": {
             "$ref": "#/definitions/add-on"
           },
@@ -1622,8 +1674,24 @@
       "description": "Add-ons represent add-ons that have been provisioned and attached to one or more apps.",
       "$schema": "http://json-schema.org/draft-04/hyper-schema",
       "stability": "production",
-      "strictProperties": true,
       "title": "Heroku Platform API - Add-on",
+      "additionalProperties": false,
+      "required": [
+        "actions",
+        "addon_service",
+        "billing_entity",
+        "app",
+        "billed_price",
+        "config_vars",
+        "created_at",
+        "id",
+        "name",
+        "plan",
+        "provider_id",
+        "state",
+        "updated_at",
+        "web_url"
+      ],
       "type": [
         "object"
       ],
@@ -1788,6 +1856,57 @@
             "null",
             "string"
           ]
+        },
+        "addon_service": {
+          "description": "identity of add-on service",
+          "anyOf": [
+            {
+              "properties": {
+                "id": {
+                  "$ref": "#/definitions/add-on-service/definitions/id"
+                },
+                "name": {
+                  "$ref": "#/definitions/add-on-service/definitions/name"
+                }
+              },
+              "strictProperties": true,
+              "type": [
+                "object"
+              ]
+            },
+            {
+              "$ref": "#/definitions/add-on-service"
+            }
+          ]
+        },
+        "plan": {
+          "description": "identity of add-on plan",
+          "anyOf": [
+            {
+              "properties": {
+                "id": {
+                  "$ref": "#/definitions/plan/definitions/id"
+                },
+                "name": {
+                  "$ref": "#/definitions/plan/definitions/name"
+                }
+              },
+              "strictProperties": true,
+              "type": [
+                "object"
+              ]
+            },
+            {
+              "$ref": "#/definitions/plan"
+            }
+          ]
+        },
+        "provision_message": {
+          "description": "A provision message",
+          "readOnly": true,
+          "type": [
+            "string"
+          ]
         }
       },
       "links": [
@@ -1918,6 +2037,9 @@
               "object"
             ]
           },
+          "targetSchema": {
+            "$ref": "#/definitions/add-on"
+          },
           "title": "Update"
         },
         {
@@ -1990,19 +2112,7 @@
           "$ref": "#/definitions/add-on/definitions/actions"
         },
         "addon_service": {
-          "description": "identity of add-on service",
-          "properties": {
-            "id": {
-              "$ref": "#/definitions/add-on-service/definitions/id"
-            },
-            "name": {
-              "$ref": "#/definitions/add-on-service/definitions/name"
-            }
-          },
-          "strictProperties": true,
-          "type": [
-            "object"
-          ]
+          "$ref": "#/definitions/add-on/definitions/addon_service"
         },
         "billing_entity": {
           "description": "billing entity associated with this add-on",
@@ -2089,23 +2199,14 @@
           "$ref": "#/definitions/add-on/definitions/name"
         },
         "plan": {
-          "description": "identity of add-on plan",
-          "properties": {
-            "id": {
-              "$ref": "#/definitions/plan/definitions/id"
-            },
-            "name": {
-              "$ref": "#/definitions/plan/definitions/name"
-            }
-          },
-          "strictProperties": true,
-          "type": [
-            "object"
-          ]
+          "$ref": "#/definitions/add-on/definitions/plan"
         },
         "provider_id": {
           "$ref": "#/definitions/add-on/definitions/provider_id"
         },
+        "provision_message": {
+          "$ref": "#/definitions/add-on/definitions/provision_message"
+        },
         "state": {
           "$ref": "#/definitions/add-on/definitions/state"
         },
@@ -2455,63 +2556,6 @@
         }
       }
     },
-    "app-formation-set": {
-      "description": "App formation set describes the combination of process types with their quantities and sizes as well as application process tier",
-      "$schema": "http://json-schema.org/draft-04/hyper-schema",
-      "stability": "development",
-      "strictProperties": true,
-      "title": "Heroku Platform API - Application Formation Set",
-      "type": [
-        "object"
-      ],
-      "properties": {
-        "description": {
-          "description": "a string representation of the formation set",
-          "example": "web@2:Standard-2X worker@3:Performance-M",
-          "readOnly": true,
-          "type": [
-            "string"
-          ]
-        },
-        "process_tier": {
-          "description": "application process tier",
-          "enum": [
-            "production",
-            "free",
-            "hobby",
-            "private"
-          ],
-          "example": "production",
-          "readOnly": true,
-          "type": [
-            "string"
-          ]
-        },
-        "app": {
-          "description": "app being described by the formation-set",
-          "properties": {
-            "name": {
-              "$ref": "#/definitions/app/definitions/name"
-            },
-            "id": {
-              "$ref": "#/definitions/app/definitions/id"
-            }
-          },
-          "type": [
-            "object"
-          ]
-        },
-        "updated_at": {
-          "description": "last time fomation-set was updated",
-          "example": "2012-01-01T12:00:00Z",
-          "format": "date-time",
-          "readOnly": true,
-          "type": [
-            "string"
-          ]
-        }
-      }
-    },
     "app-setup": {
       "description": "An app setup represents an app on Heroku that is setup using an environment, addons, and scripts described in an app.json manifest file.",
       "$schema": "http://json-schema.org/draft-04/hyper-schema",
@@ -3839,9 +3883,10 @@
           "description": "web URL of app",
           "example": "https://example.herokuapp.com/",
           "format": "uri",
-          "pattern": "^https?://[a-z][a-z0-9-]{3,30}\\.herokuapp\\.com/$",
+          "pattern": "^https?://[a-z][a-z0-9-]{3,43}\\.herokuapp\\.com/$",
           "readOnly": true,
           "type": [
+            "null",
             "string"
           ]
         },
@@ -4494,7 +4539,15 @@
       "description": "A build represents the process of transforming a code tarball into a slug",
       "title": "Heroku Build API - Build",
       "stability": "production",
-      "strictProperties": true,
+      "strictProperties": false,
+      "required": [
+        "created_at",
+        "id",
+        "source_blob",
+        "status",
+        "updated_at",
+        "user"
+      ],
       "type": [
         "object"
       ],
@@ -4617,6 +4670,15 @@
                 "string",
                 "null"
               ]
+            },
+            "version_description": {
+              "description": "Version description of the gzipped tarball.",
+              "example": "* Fake User: Change session key",
+              "readOnly": true,
+              "type": [
+                "string",
+                "null"
+              ]
             }
           },
           "strictProperties": true,
@@ -4626,7 +4688,7 @@
         },
         "stack": {
           "description": "stack of build",
-          "example": "heroku-16",
+          "example": "heroku-22",
           "readOnly": true,
           "type": [
             "string"
@@ -4717,6 +4779,16 @@
           "method": "DELETE",
           "rel": "empty",
           "title": "Delete cache"
+        },
+        {
+          "description": "Cancel running build.",
+          "href": "/apps/{(%23%2Fdefinitions%2Fapp%2Fdefinitions%2Fidentity)}/builds/{(%23%2Fdefinitions%2Fbuild%2Fdefinitions%2Fidentity)}",
+          "method": "DELETE",
+          "rel": "self",
+          "targetSchema": {
+            "$ref": "#/definitions/build"
+          },
+          "title": "Cancel"
         }
       ],
       "properties": {
@@ -5661,7 +5733,7 @@
         },
         "name": {
           "description": "the name of this dyno-size",
-          "example": "free",
+          "example": "eco",
           "readOnly": true,
           "type": [
             "string"
@@ -5694,13 +5766,22 @@
           }
         },
         "dyno_units": {
-          "description": "unit of consumption for Heroku Enterprise customers",
+          "deprecated": true,
+          "description": "deprecated. See precise_dyno_units instead",
           "example": 0,
           "readOnly": true,
           "type": [
             "integer"
           ]
         },
+        "precise_dyno_units": {
+          "description": "unit of consumption for Heroku Enterprise customers to 2 decimal places",
+          "example": 0.28,
+          "readOnly": true,
+          "type": [
+            "number"
+          ]
+        },
         "private_space_only": {
           "description": "whether this dyno can only be provisioned in a private space",
           "example": false,
@@ -5750,6 +5831,9 @@
         "dyno_units": {
           "$ref": "#/definitions/dyno-size/definitions/dyno_units"
         },
+        "precise_dyno_units": {
+          "$ref": "#/definitions/dyno-size/definitions/precise_dyno_units"
+        },
         "id": {
           "$ref": "#/definitions/dyno-size/definitions/id"
         },
@@ -5865,7 +5949,7 @@
           ]
         },
         "size": {
-          "description": "dyno size (default: \"standard-1X\")",
+          "description": "dyno size",
           "example": "standard-1X",
           "readOnly": false,
           "type": [
@@ -6767,6 +6851,9 @@
           "anyOf": [
             {
               "$ref": "#/definitions/enterprise-account/definitions/id"
+            },
+            {
+              "$ref": "#/definitions/enterprise-account/definitions/name"
             }
           ]
         },
@@ -6849,6 +6936,9 @@
           "href": "/enterprise-accounts/{(%23%2Fdefinitions%2Fenterprise-account%2Fdefinitions%2Fidentity)}",
           "method": "GET",
           "rel": "self",
+          "targetSchema": {
+            "$ref": "#/definitions/enterprise-account"
+          },
           "title": "Info"
         },
         {
@@ -7014,7 +7104,7 @@
           ]
         },
         "size": {
-          "description": "dyno size (default: \"standard-1X\")",
+          "description": "dyno size",
           "example": "standard-1X",
           "readOnly": false,
           "type": [
@@ -7188,7 +7278,7 @@
       }
     },
     "identity-provider": {
-      "description": "Identity Providers represent the SAML configuration of an Enterprise Account or Team.",
+      "description": "Identity Providers represent the SAML configuration of teams or an Enterprise account",
       "$schema": "http://json-schema.org/draft-04/hyper-schema",
       "stability": "production",
       "strictProperties": true,
@@ -7691,6 +7781,9 @@
           "href": "/account/invoice-address",
           "method": "GET",
           "rel": "self",
+          "targetSchema": {
+            "$ref": "#/definitions/invoice-address"
+          },
           "title": "info"
         },
         {
@@ -7729,6 +7822,9 @@
             "type": [
               "object"
             ]
+          },
+          "targetSchema": {
+            "$ref": "#/definitions/invoice-address"
           }
         }
       ],
@@ -8069,7 +8165,11 @@
           "description": "add-on that created the drain",
           "example": {
             "id": "01234567-89ab-cdef-0123-456789abcdef",
-            "name": "singing-swiftly-1242"
+            "name": "singing-swiftly-1242",
+            "app": {
+              "id": "01234567-89ab-cdef-0123-456789abcdef",
+              "name": "example"
+            }
           },
           "properties": {
             "id": {
@@ -8077,6 +8177,21 @@
             },
             "name": {
               "$ref": "#/definitions/add-on/definitions/name"
+            },
+            "app": {
+              "description": "billing application associated with this add-on",
+              "type": [
+                "object"
+              ],
+              "properties": {
+                "id": {
+                  "$ref": "#/definitions/app/definitions/id"
+                },
+                "name": {
+                  "$ref": "#/definitions/app/definitions/name"
+                }
+              },
+              "strictProperties": true
             }
           },
           "readOnly": true,
@@ -8085,6 +8200,27 @@
             "null"
           ]
         },
+        "app": {
+          "description": "application that is attached to this drain",
+          "example": {
+            "id": "01234567-89ab-cdef-0123-456789abcdef",
+            "name": "example"
+          },
+          "properties": {
+            "id": {
+              "$ref": "#/definitions/app/definitions/id"
+            },
+            "name": {
+              "$ref": "#/definitions/app/definitions/name"
+            }
+          },
+          "strictProperties": true,
+          "readOnly": true,
+          "type": [
+            "object",
+            "null"
+          ]
+        },
         "created_at": {
           "description": "when log drain was created",
           "example": "2012-01-01T12:00:00Z",
@@ -8251,6 +8387,9 @@
         "addon": {
           "$ref": "#/definitions/log-drain/definitions/addon"
         },
+        "app": {
+          "$ref": "#/definitions/log-drain/definitions/app"
+        },
         "created_at": {
           "$ref": "#/definitions/log-drain/definitions/created_at"
         },
@@ -8770,7 +8909,7 @@
           "title": "Delete"
         },
         {
-          "description": "Info for an OAuth client",
+          "description": "Info for an OAuth client. The output for unauthenticated requests excludes the `secret` parameter.",
           "href": "/oauth/clients/{(%23%2Fdefinitions%2Foauth-client%2Fdefinitions%2Fidentity)}",
           "method": "GET",
           "rel": "self",
@@ -8951,7 +9090,7 @@
         },
         "token": {
           "description": "contents of the token to be used for authorization",
-          "example": "01234567-89ab-cdef-0123-456789abcdef",
+          "example": "HRKU-01234567-89ab-cdef-0123-456789abcdef",
           "readOnly": true,
           "type": [
             "string"
@@ -9149,9 +9288,11 @@
     "outbound-ruleset": {
       "description": "An outbound-ruleset is a collection of rules that specify what hosts Dynos are allowed to communicate with. ",
       "$schema": "http://json-schema.org/draft-04/hyper-schema",
-      "stability": "prototype",
+      "stability": "deprecation",
       "strictProperties": true,
       "title": "Heroku Platform API - Outbound Ruleset",
+      "deprecated_at": "2024-04-30",
+      "deactivate_on": "2024-06-03",
       "type": [
         "object"
       ],
@@ -9382,10 +9523,16 @@
                 "$ref": "#/definitions/account/definitions/email"
               }
             },
+            "required": [
+              "email"
+            ],
             "type": [
               "object"
             ]
           },
+          "targetSchema": {
+            "$ref": "#/definitions/password-reset"
+          },
           "title": "Reset Password"
         },
         {
@@ -9402,10 +9549,17 @@
                 "$ref": "#/definitions/password-reset/definitions/password_confirmation"
               }
             },
+            "required": [
+              "password",
+              "password_confirmation"
+            ],
             "type": [
               "object"
             ]
           },
+          "targetSchema": {
+            "$ref": "#/definitions/password-reset"
+          },
           "title": "Complete Reset Password"
         }
       ],
@@ -9635,14 +9789,20 @@
           "href": "/spaces/{(%23%2Fdefinitions%2Fspace%2Fdefinitions%2Fidentity)}/peerings/{(%23%2Fdefinitions%2Fpeering%2Fdefinitions%2Fpcx_id)}/actions/accept",
           "method": "POST",
           "rel": "empty",
-          "title": "Accept"
+          "title": "Accept",
+          "targetSchema": {
+            "$ref": "#/definitions/peering"
+          }
         },
         {
           "description": "Destroy an active peering connection with a private space.",
           "href": "/spaces/{(%23%2Fdefinitions%2Fspace%2Fdefinitions%2Fidentity)}/peerings/{(%23%2Fdefinitions%2Fpeering%2Fdefinitions%2Fpcx_id)}",
           "rel": "empty",
           "method": "DELETE",
-          "title": "Destroy"
+          "title": "Destroy",
+          "targetSchema": {
+            "$ref": "#/definitions/peering"
+          }
         },
         {
           "description": "Fetch information for existing peering connection",
@@ -11267,12 +11427,14 @@
                 "ap-southeast-1",
                 "ap-southeast-2",
                 "eu-central-1",
+                "eu-west-2",
                 "ap-northeast-2",
                 "ap-northeast-1",
                 "us-east-1",
                 "sa-east-1",
                 "us-west-1",
-                "us-west-2"
+                "us-west-2",
+                "ca-central-1"
               ]
             }
           },
@@ -13294,7 +13456,7 @@
     "space": {
       "description": "A space is an isolated, highly available, secure app execution environment.",
       "$schema": "http://json-schema.org/draft-04/hyper-schema",
-      "stability": "prototype",
+      "stability": "production",
       "strictProperties": true,
       "title": "Heroku Platform API - Space",
       "type": [
@@ -13957,11 +14119,7 @@
           ]
         },
         "identity": {
-          "anyOf": [
-            {
-              "$ref": "#/definitions/app/definitions/name"
-            }
-          ]
+          "$ref": "#/definitions/app/definitions/name"
         },
         "internal_routing": {
           "default": false,
@@ -14027,6 +14185,9 @@
               "object"
             ]
           },
+          "targetSchema": {
+            "$ref": "#/definitions/team-app"
+          },
           "title": "Create"
         },
         {
@@ -14034,6 +14195,9 @@
           "href": "/teams/apps/{(%23%2Fdefinitions%2Fteam-app%2Fdefinitions%2Fidentity)}",
           "method": "GET",
           "rel": "self",
+          "targetSchema": {
+            "$ref": "#/definitions/team-app"
+          },
           "title": "Info"
         },
         {
@@ -14437,6 +14601,58 @@
         }
       }
     },
+    "team-delinquency": {
+      "description": "A Heroku team becomes delinquent due to non-payment. We [suspend and delete](https://help.heroku.com/EREVRILX/what-happens-if-i-have-unpaid-heroku-invoices) delinquent teams if their invoices remain unpaid.",
+      "$schema": "http://json-schema.org/draft-04/hyper-schema",
+      "stability": "development",
+      "strictProperties": true,
+      "title": "Heroku Platform API - Team Delinquency",
+      "type": [
+        "object"
+      ],
+      "definitions": {
+        "scheduled_suspension_time": {
+          "description": "scheduled time of when we will suspend your team due to delinquency",
+          "example": "2024-01-01T12:00:00Z",
+          "format": "date-time",
+          "readOnly": true,
+          "type": [
+            "string",
+            "null"
+          ]
+        },
+        "scheduled_deletion_time": {
+          "description": "scheduled time of when we will delete your team due to delinquency",
+          "example": "2024-01-01T12:00:00Z",
+          "format": "date-time",
+          "readOnly": true,
+          "type": [
+            "string",
+            "null"
+          ]
+        }
+      },
+      "links": [
+        {
+          "description": "Team delinquency information.",
+          "href": "/teams/{(%23%2Fdefinitions%2Fteam%2Fdefinitions%2Fidentity)}/delinquency",
+          "method": "GET",
+          "rel": "self",
+          "targetSchema": {
+            "$ref": "#/definitions/team-delinquency"
+          },
+          "title": "Info"
+        }
+      ],
+      "properties": {
+        "scheduled_suspension_time": {
+          "$ref": "#/definitions/team-delinquency/definitions/scheduled_suspension_time"
+        },
+        "scheduled_deletion_time": {
+          "$ref": "#/definitions/team-delinquency/definitions/scheduled_deletion_time"
+        }
+      }
+    },
     "team-feature": {
       "description": "A team feature represents a feature enabled on a team account.",
       "$schema": "http://json-schema.org/draft-04/hyper-schema",
@@ -14692,6 +14908,9 @@
             "type": [
               "object"
             ]
+          },
+          "targetSchema": {
+            "$ref": "#/definitions/team-invitation"
           }
         },
         {
@@ -14699,7 +14918,10 @@
           "title": "Revoke",
           "href": "/teams/{(%23%2Fdefinitions%2Fteam%2Fdefinitions%2Fidentity)}/invitations/{(%23%2Fdefinitions%2Fteam-invitation%2Fdefinitions%2Fidentity)}",
           "method": "DELETE",
-          "rel": "self"
+          "rel": "self",
+          "targetSchema": {
+            "$ref": "#/definitions/team-invitation"
+          }
         },
         {
           "description": "Get an invitation by its token",
@@ -15094,7 +15316,7 @@
           ]
         },
         "two_factor_authentication": {
-          "description": "whether the Enterprise team member has two factor authentication enabled",
+          "description": "whether the team member has two factor authentication enabled",
           "example": true,
           "readOnly": true,
           "type": [
@@ -15907,6 +16129,9 @@
           "href": "/teams/{(%23%2Fdefinitions%2Fteam%2Fdefinitions%2Fidentity)}",
           "method": "GET",
           "rel": "self",
+          "targetSchema": {
+            "$ref": "#/definitions/team"
+          },
           "title": "Info"
         },
         {
@@ -17174,6 +17399,9 @@
           "href": "/spaces/{(%23%2Fdefinitions%2Fspace%2Fdefinitions%2Fidentity)}/vpn-connections/{(%23%2Fdefinitions%2Fvpn-connection%2Fdefinitions%2Fidentity)}",
           "rel": "empty",
           "method": "DELETE",
+          "targetSchema": {
+            "$ref": "#/definitions/vpn-connection"
+          },
           "title": "Destroy"
         },
         {
@@ -17228,6 +17456,9 @@
     }
   },
   "properties": {
+    "account-delinquency": {
+      "$ref": "#/definitions/account-delinquency"
+    },
     "account-feature": {
       "$ref": "#/definitions/account-feature"
     },
@@ -17270,9 +17501,6 @@
     "app-feature": {
       "$ref": "#/definitions/app-feature"
     },
-    "app-formation-set": {
-      "$ref": "#/definitions/app-formation-set"
-    },
     "app-setup": {
       "$ref": "#/definitions/app-setup"
     },
@@ -17480,6 +17708,9 @@
     "team-daily-usage": {
       "$ref": "#/definitions/team-daily-usage"
     },
+    "team-delinquency": {
+      "$ref": "#/definitions/team-delinquency"
+    },
     "team-feature": {
       "$ref": "#/definitions/team-feature"
     },