Updates the cloud resource plan

Updates the cloud resource plan

Path Parameters

name stringrequired

The name of the cloud resource plan you wish or update

Query Parameters

dryRun string

Set to 'All' to perform a server-side dry run of updating this resource

force string

Set to 'true' to override read-only (has no effect unless used by Wayfinder admin)

owner string

Use an explicit owner for this resource - this must match the owner used on create, if set

apply string

Use server-side apply for this update instead of overwriting the whole object

application/json

Request Body required

The specification for the cloud resource plan you are updating

apiVersion string
kind string
metadata
ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create.
annotations object
Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: http://kubernetes.io/docs/user-guide/annotations
property name* string
clusterName string
creationTimestamp string
deletionGracePeriodSeconds int64
deletionTimestamp string
finalizers string[]
generateName string
generation int64
labels object
Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services. More info: http://kubernetes.io/docs/user-guide/labels
property name* string
managedFields undefined[]
ManagedFields maps workflow-id and version to the set of fields that are managed by that workflow. This is mostly for internal housekeeping, and users typically shouldn't need to set or understand this field. A workflow can be the user's name, a controller's name, or the name of a specific apply path like "ci-cd". The set of fields is always in the version that the workflow used when modifying the object.
apiVersion string
fieldsType string
fieldsV1 string
manager string
operation string
subresource string
time string
name string
namespace string
ownerReferences undefined[]
List of objects depended by this object. If ALL objects in the list have been deleted, this object will be garbage collected. If this object is managed by a controller, then an entry in this list will point to this controller, with the controller field set to true. There cannot be more than one managing controller.
apiVersion stringrequired
blockOwnerDeletion boolean
controller boolean
kind stringrequired
name stringrequired
uid stringrequired
resourceVersion string
selfLink string
uid string
spec
CloudResourcePlanSpec defines a plan for a cloud resource.
allocation
type stringrequired
workspaces string[]
cloud stringrequired
description stringrequired
enableTemplateAutoUpgrade booleanrequired
enableWatch booleanrequired
inputDefinitions undefined[]
InoutDefinitions provides more detail about the inputs that the terraform module represented by this plan has.
default string
description string
name stringrequired
required boolean
sensitive boolean
type string
inputsFrom undefined[]
InputsFrom is a optional collection of values which are injected into the rendered output of the resource.
kind stringrequired
name stringrequired
resource
Resource is used to filter on and extract the details from a managed resource in Wayfinder.
group stringrequired
kind stringrequired
name stringrequired
namespace stringrequired
srcPath stringrequired
valuePrefix string
valueSuffix string
version stringrequired
labels object
property name* string
outputs undefined[]
Outputs is a list of available outputs from the revision of the terraform module represented by this plan.
description string
name stringrequired
sensitive boolean
userFacing boolean
policies undefined[]
editable boolean
enum string[]
max int64
min int64
path string
pattern string
summary string
template required
Template represents the configuration values for a specific revision of the cloud resource.
revision stringrequired
source stringrequired
variables object
status
CloudResourcePlanStatus defines the status of a cloud resource plan.
cloudResourcesCreated boolean
conditions undefined[]
detail string
lastTransitionTime stringrequired
message string
name stringrequired
negativePolarity boolean
observedGeneration int64
reason stringrequired
status stringrequired
type stringrequired
detail string
lastReconcile
generation int64required
time stringrequired
lastSuccess
generation int64required
time stringrequired
message string
obsoleteResources undefined[]
kind stringrequired
name stringrequired
status stringrequired
wayfinderVersion string

Responses

200

Contains the cloud resource plan definition

application/json

Schema

Schema

apiVersion string
kind string
metadata
ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create.
annotations object
Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: http://kubernetes.io/docs/user-guide/annotations
property name* string
clusterName string
creationTimestamp string
deletionGracePeriodSeconds int64
deletionTimestamp string
finalizers string[]
generateName string
generation int64
labels object
Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services. More info: http://kubernetes.io/docs/user-guide/labels
property name* string
managedFields undefined[]
ManagedFields maps workflow-id and version to the set of fields that are managed by that workflow. This is mostly for internal housekeeping, and users typically shouldn't need to set or understand this field. A workflow can be the user's name, a controller's name, or the name of a specific apply path like "ci-cd". The set of fields is always in the version that the workflow used when modifying the object.
apiVersion string
fieldsType string
fieldsV1 string
manager string
operation string
subresource string
time string
name string
namespace string
ownerReferences undefined[]
List of objects depended by this object. If ALL objects in the list have been deleted, this object will be garbage collected. If this object is managed by a controller, then an entry in this list will point to this controller, with the controller field set to true. There cannot be more than one managing controller.
apiVersion string
blockOwnerDeletion boolean
controller boolean
kind string
name string
uid string
resourceVersion string
selfLink string
uid string
spec
CloudResourcePlanSpec defines a plan for a cloud resource.
allocation
type string
workspaces string[]
cloud string
description string
enableTemplateAutoUpgrade boolean
enableWatch boolean
inputDefinitions undefined[]
InoutDefinitions provides more detail about the inputs that the terraform module represented by this plan has.
default string
description string
name string
required boolean
sensitive boolean
type string
inputsFrom undefined[]
InputsFrom is a optional collection of values which are injected into the rendered output of the resource.
kind string
name string
resource
Resource is used to filter on and extract the details from a managed resource in Wayfinder.
group string
kind string
name string
namespace string
srcPath string
valuePrefix string
valueSuffix string
version string
labels object
property name* string
outputs undefined[]
Outputs is a list of available outputs from the revision of the terraform module represented by this plan.
description string
name string
sensitive boolean
userFacing boolean
policies undefined[]
editable boolean
enum string[]
max int64
min int64
path string
pattern string
summary string
template
Template represents the configuration values for a specific revision of the cloud resource.
revision string
source string
variables object
status
CloudResourcePlanStatus defines the status of a cloud resource plan.
cloudResourcesCreated boolean
conditions undefined[]
detail string
lastTransitionTime string
message string
name string
negativePolarity boolean
observedGeneration int64
reason string
status string
type string
detail string
lastReconcile
generation int64
time string
lastSuccess
generation int64
time string
message string
obsoleteResources undefined[]
kind string
name string
status string
wayfinderVersion string

Example (from schema)

{
  "apiVersion": "string",
  "kind": "string",
  "metadata": {
    "annotations": {},
    "clusterName": "string",
    "creationTimestamp": "string",
    "deletionGracePeriodSeconds": 0,
    "deletionTimestamp": "string",
    "finalizers": [
      "string"
    ],
    "generateName": "string",
    "generation": 0,
    "labels": {},
    "managedFields": [
      {
        "apiVersion": "string",
        "fieldsType": "string",
        "fieldsV1": "string",
        "manager": "string",
        "operation": "string",
        "subresource": "string",
        "time": "string"
      }
    ],
    "name": "string",
    "namespace": "string",
    "ownerReferences": [
      {
        "apiVersion": "string",
        "blockOwnerDeletion": true,
        "controller": true,
        "kind": "string",
        "name": "string",
        "uid": "string"
      }
    ],
    "resourceVersion": "string",
    "selfLink": "string",
    "uid": "string"
  },
  "spec": {
    "allocation": {
      "type": "string",
      "workspaces": [
        "string"
      ]
    },
    "cloud": "string",
    "description": "string",
    "enableTemplateAutoUpgrade": true,
    "enableWatch": true,
    "inputDefinitions": [
      {
        "default": "string",
        "description": "string",
        "name": "string",
        "required": true,
        "sensitive": true,
        "type": "string"
      }
    ],
    "inputsFrom": [
      {
        "kind": "string",
        "name": "string",
        "resource": {
          "group": "string",
          "kind": "string",
          "name": "string",
          "namespace": "string",
          "srcPath": "string",
          "valuePrefix": "string",
          "valueSuffix": "string",
          "version": "string"
        }
      }
    ],
    "labels": {},
    "outputs": [
      {
        "description": "string",
        "name": "string",
        "sensitive": true,
        "userFacing": true
      }
    ],
    "policies": [
      {
        "editable": true,
        "enum": [
          "string"
        ],
        "max": 0,
        "min": 0,
        "path": "string",
        "pattern": "string",
        "summary": "string"
      }
    ],
    "template": {
      "revision": "string",
      "source": "string",
      "variables": {}
    }
  },
  "status": {
    "cloudResourcesCreated": true,
    "conditions": [
      {
        "detail": "string",
        "lastTransitionTime": "string",
        "message": "string",
        "name": "string",
        "negativePolarity": true,
        "observedGeneration": 0,
        "reason": "string",
        "status": "string",
        "type": "string"
      }
    ],
    "detail": "string",
    "lastReconcile": {
      "generation": 0,
      "time": "string"
    },
    "lastSuccess": {
      "generation": 0,
      "time": "string"
    },
    "message": "string",
    "obsoleteResources": [
      {
        "kind": "string",
        "name": "string"
      }
    ],
    "status": "string",
    "wayfinderVersion": "string"
  }
}

400

Validation error of supplied parameters/body

application/json

Schema

Schema

code int32
fieldErrors undefined[]
errCode string
field string
message string
message string

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 int32
detail string
message string
uri string
verb string

Example (from schema)

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

Loading...