schema.json in platform-api-0.6.0 vs schema.json in platform-api-0.7.0
- old
+ new
@@ -597,10 +597,83 @@
"null"
]
}
}
},
+ "addon-action": {
+ "description": "Add-on Actions are Provider functionality for specific add-on installations",
+ "$schema": "http://json-schema.org/draft-04/hyper-schema",
+ "stability": "development",
+ "strictProperties": true,
+ "title": "Heroku Platform API - Add-on Action",
+ "type": [
+ "object"
+ ],
+ "definitions": {
+ "id": {
+ "description": "a unique identifier",
+ "example": "01234567-89ab-cdef-0123-456789abcdef",
+ "format": "uuid",
+ "readOnly": true,
+ "type": [
+ "string"
+ ]
+ },
+ "identity": {
+ "$ref": "#/definitions/addon-action/definitions/id"
+ },
+ "label": {
+ "description": "the display text shown in Dashboard",
+ "example": "Example",
+ "readOnly": true,
+ "type": [
+ "string"
+ ]
+ },
+ "action": {
+ "description": "identifier of the action to take that is sent via SSO",
+ "example": "example",
+ "readOnly": true,
+ "type": [
+ "string"
+ ]
+ },
+ "url": {
+ "description": "absolute URL to use instead of an action",
+ "example": "http://example.com?resource_id=:resource_id",
+ "readOnly": true,
+ "type": [
+ "string"
+ ]
+ },
+ "requires_owner": {
+ "description": "if the action requires the user to own the app",
+ "example": true,
+ "readOnly": true,
+ "type": [
+ "boolean"
+ ]
+ }
+ },
+ "properties": {
+ "id": {
+ "$ref": "#/definitions/addon-action/definitions/id"
+ },
+ "label": {
+ "$ref": "#/definitions/addon-action/definitions/label"
+ },
+ "action": {
+ "$ref": "#/definitions/addon-action/definitions/action"
+ },
+ "url": {
+ "$ref": "#/definitions/addon-action/definitions/url"
+ },
+ "requires_owner": {
+ "$ref": "#/definitions/addon-action/definitions/requires_owner"
+ }
+ }
+ },
"addon-attachment": {
"description": "An add-on attachment represents a connection between an app and an add-on that it has been given access to.",
"$schema": "http://json-schema.org/draft-04/hyper-schema",
"stability": "prototype",
"strictProperties": true,
@@ -852,10 +925,102 @@
"web_url": {
"$ref": "#/definitions/addon-attachment/definitions/web_url"
}
}
},
+ "addon-region-capability": {
+ "description": "Add-on region capabilities represent the relationship between an Add-on Service and a specific Region",
+ "$schema": "http://json-schema.org/draft-04/hyper-schema",
+ "stability": "production",
+ "strictProperties": true,
+ "title": "Heroku Platform API - Add-on Region Capability",
+ "type": [
+ "object"
+ ],
+ "definitions": {
+ "id": {
+ "description": "unique identifier of this addon-region-capability",
+ "example": "01234567-89ab-cdef-0123-456789abcdef",
+ "format": "uuid",
+ "readOnly": true,
+ "type": [
+ "string"
+ ]
+ },
+ "supports_private_networking": {
+ "description": "whether the add-on can be installed to a Space",
+ "readOnly": true,
+ "type": [
+ "boolean"
+ ]
+ },
+ "identity": {
+ "$ref": "#/definitions/addon-region-capability/definitions/id"
+ }
+ },
+ "links": [
+ {
+ "description": "List all existing add-on region capabilities.",
+ "href": "/addon-region-capabilities",
+ "method": "GET",
+ "rel": "instances",
+ "targetSchema": {
+ "items": {
+ "$ref": "#/definitions/addon-region-capability"
+ },
+ "type": [
+ "array"
+ ]
+ },
+ "title": "List"
+ },
+ {
+ "description": "List existing add-on region capabilities for an addon-service",
+ "href": "/addon-services/{(%23%2Fdefinitions%2Faddon-service%2Fdefinitions%2Fidentity)}/region-capabilities",
+ "method": "GET",
+ "rel": "instances",
+ "targetSchema": {
+ "items": {
+ "$ref": "#/definitions/addon-region-capability"
+ },
+ "type": [
+ "array"
+ ]
+ },
+ "title": "List by Add-on Service"
+ },
+ {
+ "description": "List existing add-on region capabilities for a region.",
+ "href": "/regions/{(%23%2Fdefinitions%2Fregion%2Fdefinitions%2Fidentity)}/addon-region-capabilities",
+ "method": "GET",
+ "rel": "instances",
+ "targetSchema": {
+ "items": {
+ "$ref": "#/definitions/addon-region-capability"
+ },
+ "type": [
+ "array"
+ ]
+ },
+ "title": "List"
+ }
+ ],
+ "properties": {
+ "id": {
+ "$ref": "#/definitions/addon-region-capability/definitions/id"
+ },
+ "supports_private_networking": {
+ "$ref": "#/definitions/addon-region-capability/definitions/supports_private_networking"
+ },
+ "addon_service": {
+ "$ref": "#/definitions/addon-service"
+ },
+ "region": {
+ "$ref": "#/definitions/region"
+ }
+ }
+ },
"addon-service": {
"description": "Add-on services represent add-ons that may be provisioned for apps. Endpoints under add-on services can be accessed without authentication.",
"$schema": "http://json-schema.org/draft-04/hyper-schema",
"stability": "production",
"strictProperties": true,
@@ -1024,10 +1189,39 @@
"title": "Heroku Platform API - Add-on",
"type": [
"object"
],
"definitions": {
+ "actions": {
+ "description": "provider actions for this specific add-on",
+ "type": [
+ "array"
+ ],
+ "items": {
+ "type": [
+ "object"
+ ]
+ },
+ "readOnly": true,
+ "properties": {
+ "id": {
+ "$ref": "#/definitions/addon-action/definitions/id"
+ },
+ "label": {
+ "$ref": "#/definitions/addon-action/definitions/label"
+ },
+ "action": {
+ "$ref": "#/definitions/addon-action/definitions/action"
+ },
+ "url": {
+ "$ref": "#/definitions/addon-action/definitions/url"
+ },
+ "requires_owner": {
+ "$ref": "#/definitions/addon-action/definitions/requires_owner"
+ }
+ }
+ },
"config_vars": {
"description": "config vars exposed to the owning app by this add-on",
"example": [
"FOO",
"BAZ"
@@ -1240,10 +1434,13 @@
},
"title": "Update"
}
],
"properties": {
+ "actions": {
+ "$ref": "#/definitions/addon/definitions/actions"
+ },
"addon_service": {
"description": "identity of add-on service",
"properties": {
"id": {
"$ref": "#/definitions/addon-service/definitions/id"
@@ -1693,11 +1890,10 @@
"object"
]
},
"source_blob": {
"description": "gzipped tarball of source code containing app.json manifest file",
- "example": "https://example.com/source.tgz?token=xyz",
"properties": {
"checksum": {
"description": "an optional checksum of the gzipped tarball for verifying its integrity",
"example": "SHA256:e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855",
"readOnly": true,
@@ -3416,11 +3612,11 @@
"$ref": "#/definitions/domain/definitions/updated_at"
}
}
},
"dyno": {
- "description": "Dynos encapsulate running processes of an app on Heroku.",
+ "description": "Dynos encapsulate running processes of an app on Heroku. Detailed information about dyno sizes can be found at: [https://devcenter.heroku.com/articles/dyno-types](https://devcenter.heroku.com/articles/dyno-types).",
"$schema": "http://json-schema.org/draft-04/hyper-schema",
"stability": "production",
"strictProperties": true,
"title": "Heroku Platform API - Dyno",
"type": [
@@ -3506,10 +3702,19 @@
"readOnly": true,
"type": [
"string"
]
},
+ "force_no_tty": {
+ "description": "force an attached one-off dyno to not run in a tty",
+ "example": null,
+ "readOnly": false,
+ "type": [
+ "boolean",
+ "null"
+ ]
+ },
"size": {
"description": "dyno size (default: \"standard-1X\")",
"example": "standard-1X",
"readOnly": false,
"type": [
@@ -3557,10 +3762,13 @@
"$ref": "#/definitions/dyno/definitions/command"
},
"env": {
"$ref": "#/definitions/dyno/definitions/env"
},
+ "force_no_tty": {
+ "$ref": "#/definitions/dyno/definitions/force_no_tty"
+ },
"size": {
"$ref": "#/definitions/dyno/definitions/size"
}
},
"required": [
@@ -3758,10 +3966,13 @@
},
{
"$ref": "#/definitions/formation"
},
{
+ "$ref": "#/definitions/organization"
+ },
+ {
"$ref": "#/definitions/release"
},
{
"$ref": "#/definitions/space"
}
@@ -3809,10 +4020,11 @@
"collaborator",
"domain",
"dyno",
"failed-event",
"formation",
+ "organization",
"release",
"space",
"user"
],
"example": "app",
@@ -4031,10 +4243,74 @@
"null"
]
}
}
},
+ "filter-apps": {
+ "description": "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.",
+ "$schema": "http://json-schema.org/draft-04/hyper-schema",
+ "stability": "development",
+ "title": "Heroku Platform API - Filters",
+ "type": [
+ "object"
+ ],
+ "definitions": {
+ "filter": {
+ "type": [
+ "object"
+ ],
+ "properties": {
+ "in": {
+ "$ref": "#/definitions/filter-apps/definitions/in"
+ }
+ }
+ },
+ "in": {
+ "type": [
+ "object"
+ ],
+ "properties": {
+ "id": {
+ "$ref": "#/definitions/filter-apps/definitions/id"
+ }
+ }
+ },
+ "id": {
+ "type": [
+ "array"
+ ],
+ "items": {
+ "$ref": "#/definitions/app/definitions/id"
+ }
+ }
+ },
+ "links": [
+ {
+ "description": "Request an apps list filtered by app id.",
+ "title": "Apps",
+ "href": "/filters/apps",
+ "method": "POST",
+ "ranges": [
+ "id",
+ "name",
+ "updated_at"
+ ],
+ "rel": "instances",
+ "schema": {
+ "$ref": "#/definitions/filter-apps/definitions/filter"
+ },
+ "targetSchema": {
+ "items": {
+ "$ref": "#/definitions/organization-app"
+ },
+ "type": [
+ "array"
+ ]
+ }
+ }
+ ]
+ },
"formation": {
"description": "The formation of processes that should be maintained for an app. Update the formation to scale processes or change dyno sizes. Available process type names and commands are defined by the `process_types` attribute for the [slug](#slug) currently released on an app.",
"$schema": "http://json-schema.org/draft-04/hyper-schema",
"stability": "production",
"strictProperties": true,
@@ -5731,10 +6007,20 @@
},
"targetSchema": {
"$ref": "#/definitions/oauth-client"
},
"title": "Update"
+ },
+ {
+ "description": "Rotate credentials for an OAuth client",
+ "href": "/oauth/clients/{(%23%2Fdefinitions%2Foauth-client%2Fdefinitions%2Fidentity)}/actions/rotate-credentials",
+ "method": "POST",
+ "rel": "update",
+ "targetSchema": {
+ "$ref": "#/definitions/oauth-client"
+ },
+ "title": "Rotate Credentials"
}
],
"properties": {
"created_at": {
"$ref": "#/definitions/oauth-client/definitions/created_at"
@@ -6099,11 +6385,11 @@
]
}
},
"links": [
{
- "description": "Create a new collaborator on an organization app. Use this endpoint instead of the `/apps/{app_id_or_name}/collaborator` endpoint when you want the collaborator to be granted [privileges] (https://devcenter.heroku.com/articles/org-users-access#roles-and-app-privileges) according to their role in the organization.",
+ "description": "Create a new collaborator on an organization app. Use this endpoint instead of the `/apps/{app_id_or_name}/collaborator` endpoint when you want the collaborator to be granted [permissions] (https://devcenter.heroku.com/articles/org-users-access#roles-and-app-permissions) according to their role in the organization.",
"href": "/organizations/apps/{(%23%2Fdefinitions%2Fapp%2Fdefinitions%2Fidentity)}/collaborators",
"method": "POST",
"rel": "create",
"schema": {
"properties": {
@@ -7279,15 +7565,17 @@
"description": "role in the organization",
"enum": [
"admin",
"collaborator",
"member",
- "owner"
+ "owner",
+ null
],
"example": "admin",
"readOnly": true,
"type": [
+ "null",
"string"
]
},
"updated_at": {
"description": "when the organization was updated",
@@ -8023,11 +8311,11 @@
}
},
"links": [
{
"description": "List couplings for a pipeline",
- "href": "/pipelines/{(%23%2Fdefinitions%2Fpipeline%2Fdefinitions%2Fidentity)}/pipeline-couplings",
+ "href": "/pipelines/{(%23%2Fdefinitions%2Fpipeline%2Fdefinitions%2Fid)}/pipeline-couplings",
"method": "GET",
"rel": "instances",
"targetSchema": {
"items": {
"$ref": "#/definitions/pipeline-coupling"
@@ -8062,11 +8350,11 @@
"properties": {
"app": {
"$ref": "#/definitions/app/definitions/identity"
},
"pipeline": {
- "$ref": "#/definitions/pipeline/definitions/identity"
+ "$ref": "#/definitions/pipeline/definitions/id"
},
"stage": {
"$ref": "#/definitions/pipeline-coupling/definitions/stage"
}
},
@@ -9639,20 +9927,20 @@
]
}
}
},
"space-app-access": {
- "description": "Space access represents the privileges a particular user has on a particular space.",
+ "description": "Space access represents the permissions a particular user has on a particular space.",
"$schema": "http://json-schema.org/draft-04/hyper-schema",
"stability": "prototype",
"title": "Heroku Platform API - Space Access",
"type": [
"object"
],
"definitions": {
"id": {
- "description": "unique identifier of the space a user has privileges on",
+ "description": "unique identifier of the space a user has permissions on",
"example": "01234567-89ab-cdef-0123-456789abcdef",
"format": "uuid",
"readOnly": true,
"type": [
"string"
@@ -9666,27 +9954,27 @@
]
}
},
"links": [
{
- "description": "List privileges for a given user on a given space.",
+ "description": "List permissions for a given user on a given space.",
"href": "/spaces/{(%23%2Fdefinitions%2Fspace%2Fdefinitions%2Fidentity)}/members/{(%23%2Fdefinitions%2Faccount%2Fdefinitions%2Fidentity)}",
"method": "GET",
"rel": "self",
"targetSchema": {
"$ref": "#/definitions/space-app-access"
},
"title": "Info"
},
{
- "description": "Update an existing user's set of privileges on a space.",
+ "description": "Update an existing user's set of permissions on a space.",
"href": "/spaces/{(%23%2Fdefinitions%2Fspace%2Fdefinitions%2Fidentity)}/members/{(%23%2Fdefinitions%2Faccount%2Fdefinitions%2Fidentity)}",
"method": "PATCH",
"rel": "update",
"schema": {
"properties": {
- "privileges": {
+ "permissions": {
"type": [
"array"
],
"items": {
"type": [
@@ -9707,11 +9995,11 @@
"$ref": "#/definitions/space-app-access"
},
"title": "Update"
},
{
- "description": "List all users and their privileges on a space.",
+ "description": "List all users and their permissions on a space.",
"href": "/spaces/{(%23%2Fdefinitions%2Fspace%2Fdefinitions%2Fidentity)}/members",
"method": "GET",
"rel": "instances",
"targetSchema": {
"items": {
@@ -9744,12 +10032,12 @@
"$ref": "#/definitions/space/definitions/created_at"
},
"id": {
"$ref": "#/definitions/space/definitions/id"
},
- "privileges": {
- "description": "user space privileges",
+ "permissions": {
+ "description": "user space permissions",
"type": [
"array"
],
"items": {
"type": [
@@ -9884,10 +10172,36 @@
"title": "Heroku Platform API - Space",
"type": [
"object"
],
"definitions": {
+ "regime": {
+ "description": "compliance requirements a space must adhere to",
+ "readOnly": true,
+ "example": "HIPAA",
+ "type": [
+ "string"
+ ],
+ "enum": [
+ "HIPAA",
+ "PCI"
+ ]
+ },
+ "compliance": {
+ "description": "the compliance regimes applied to a space",
+ "example": [
+ "HIPAA"
+ ],
+ "readOnly": false,
+ "type": [
+ "null",
+ "array"
+ ],
+ "items": {
+ "$ref": "#/definitions/space/definitions/regime"
+ }
+ },
"created_at": {
"description": "when space was created",
"example": "2012-01-01T12:00:00Z",
"format": "date-time",
"readOnly": true,
@@ -10012,10 +10326,13 @@
"name": {
"$ref": "#/definitions/space/definitions/name"
},
"region": {
"$ref": "#/definitions/region/definitions/identity"
+ },
+ "compliance": {
+ "$ref": "#/definitions/space/definitions/compliance"
}
},
"required": [
"name"
],
@@ -10028,10 +10345,13 @@
},
"title": "Create"
}
],
"properties": {
+ "compliance": {
+ "$ref": "#/definitions/space/definitions/compliance"
+ },
"created_at": {
"$ref": "#/definitions/space/definitions/created_at"
},
"id": {
"$ref": "#/definitions/space/definitions/id"
@@ -10758,13 +11078,19 @@
"$ref": "#/definitions/account-feature"
},
"account": {
"$ref": "#/definitions/account"
},
+ "addon-action": {
+ "$ref": "#/definitions/addon-action"
+ },
"addon-attachment": {
"$ref": "#/definitions/addon-attachment"
},
+ "addon-region-capability": {
+ "$ref": "#/definitions/addon-region-capability"
+ },
"addon-service": {
"$ref": "#/definitions/addon-service"
},
"addon": {
"$ref": "#/definitions/addon"
@@ -10808,9 +11134,12 @@
"event": {
"$ref": "#/definitions/event"
},
"failed-event": {
"$ref": "#/definitions/failed-event"
+ },
+ "filter-apps": {
+ "$ref": "#/definitions/filter-apps"
},
"formation": {
"$ref": "#/definitions/formation"
},
"inbound-ruleset": {