ex_heroku_client v0.3.0 Heroku.AppSetup
Summary
Functions
Calls POST /app-setups
params
is JSON encoded and passed as the request body.
params Schema
{
"properties": {
"app": {
"description": "optional parameters for created app",
"properties": {
"locked": {
"default": false,
"description": "are other organization members forbidden from joining this app.",
"example": false,
"type": [
"boolean"
]
},
"name": {
"description": "unique name of app",
"example": "example",
"pattern": "^[a-z][a-z0-9-]{2,29}$",
"readOnly": false,
"type": [
"string"
]
},
"organization": {
"description": "unique name of organization",
"example": "example",
"readOnly": true,
"type": [
"string"
]
},
"personal": {
"default": false,
"description": "force creation of the app in the user account even if a default org is set.",
"example": false,
"type": [
"boolean"
]
},
"region": {
"description": "unique name of region",
"example": "us",
"readOnly": true,
"type": [
"string"
]
},
"stack": {
"description": "unique name of stack",
"example": "cedar-14",
"readOnly": true,
"type": [
"string"
]
}
},
"type": [
"object"
]
},
"overrides": {
"description": "overrides of keys in the app.json manifest file",
"example": {
"buildpacks": [
{
"url": "https://example.com/buildpack.tgz"
}
],
"env": {
"BAZ": "qux",
"FOO": "bar"
}
},
"properties": {
"buildpacks": {
"additionalItems": true,
"description": "overrides the buildpacks specified in the app.json manifest file",
"example": [
{
"url": "https://example.com/buildpack.tgz"
}
],
"items": {
"description": "a buildpack override",
"properties": {
"url": {
"description": "location of the buildpack",
"example": "https://example.com/buildpack.tgz",
"type": [
"string"
]
}
},
"type": [
"object"
]
},
"type": [
"array"
]
},
"env": {
"additionalProperties": false,
"description": "overrides of the env specified in the app.json manifest file",
"example": {
"BAZ": "qux",
"FOO": "bar"
},
"patternProperties": {
"^\\w+$": {
"type": [
"string"
]
}
},
"properties": {},
"readOnly": true,
"type": [
"object"
]
}
},
"type": [
"object"
]
},
"source_blob": {
"description": "gzipped tarball of source code containing app.json manifest file",
"properties": {
"checksum": {
"description": "an optional checksum of the gzipped tarball for verifying its integrity",
"example": "SHA256:e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855",
"readOnly": true,
"type": [
"null",
"string"
]
},
"url": {
"description": "URL of gzipped tarball of source code containing app.json manifest file",
"example": "https://example.com/source.tgz?token=xyz",
"readOnly": true,
"type": [
"string"
]
},
"version": {
"description": "Version of the gzipped tarball.",
"example": "v1.3.0",
"readOnly": true,
"type": [
"string",
"null"
]
}
},
"type": [
"object"
]
}
},
"required": [
"source_blob"
],
"type": [
"object"
]
}