Used to generate manifest for the given application environment

POST 
/resources/app.appvia.io/v2beta1/workspaces/:workspace/applications/:name/prepare

Used to generate manifest for the given application environment

Request

Path Parameters

workspace stringrequired

Workspace to use

name stringrequired

Application to use

application/json

Body

required

appEnv stringrequired

AppEnv is the name of the application environment

componentContainerImages

object

ComponentContainerImages is an optional list of images to be mapped to the named container

property name*

object

property name* string

componentContainerTags

object

ComponentContainerTags is an optional list of tags to be mapped to the named container

property name*

object

property name* string

componentImageTags

object

ImageTags is an optional set of image tag overrides for the components being deployed. If no image tag is specified here (and no entry is provided in Images), the default image from the component definition will be used.

property name* string
components string[]required

Components is the names of the components that should be returns

force boolean

Force runs the patch with force to override conflicts

imageTag string

ImageTag to use for all components, unless overridden by an entry in Images or ImageTags

images

object

Images is an optional set of image overrides for the components being deployed. If no image is specified here, the default image from the component definition will be used.

property name* string
remove boolean

Remove causes the deployment to remove all resources from the manifest instead of deploying them.

Responses

200

Contains the manifests

application/json

Schema

Schema

items

undefined[]

required

Array [

Data stringrequired

Name stringrequired

]

Example (from schema)

{
  "items": [
    {
      "Data": "string",
      "Name": "string"
    }
  ]
}

400

Validation error of supplied parameters/body

application/json

Schema

Schema

code int32required

fieldErrors

undefined[]

required

Array [

errCode stringrequired

field stringrequired

message stringrequired

]

message stringrequired

Example (from schema)

{
  "code": 0,
  "fieldErrors": [
    {
      "errCode": "string",
      "field": "string",
      "message": "string"
    }
  ],
  "message": "string"
}

401

If not authenticated

403

If authenticated but not authorized

500

A generic API error containing the cause of the error

application/json

Schema

Schema

code int32required
detail stringrequired
message stringrequired
uri stringrequired
verb stringrequired

Example (from schema)

{
  "code": 0,
  "detail": "string",
  "message": "string",
  "uri": "string",
  "verb": "string"
}

Loading...