Argo Workflows · JSON Structure

Argo Workflows Io Argoproj Workflow V1Alpha1 Parameter Structure

Parameter indicate a passed string parameter to a service template with an optional default value

Type: object Properties: 7 Required: 1
CNCFContainersData ProcessingKubernetesMachine LearningOpen SourceWorkflow Engine

io.argoproj.workflow.v1alpha1.Parameter is a JSON Structure definition published by Argo Workflows, describing 7 properties, of which 1 is required. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

default description enum globalName name value valueFrom

Meta-schema: https://json-structure.org/meta/core/v0/#

JSON Structure

Raw ↑ 
{
  "$schema": "https://json-structure.org/meta/core/v0/#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/argo-workflows/refs/heads/main/json-structure/argo-workflows-io-argoproj-workflow-v1alpha1-parameter-structure.json",
  "name": "io.argoproj.workflow.v1alpha1.Parameter",
  "description": "Parameter indicate a passed string parameter to a service template with an optional default value",
  "type": "object",
  "properties": {
    "default": {
      "description": "Default is the default value to use for an input parameter if a value was not supplied",
      "type": "string"
    },
    "description": {
      "description": "Description is the parameter description",
      "type": "string"
    },
    "enum": {
      "description": "Enum holds a list of string values to choose from, for the actual value of the parameter",
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "globalName": {
      "description": "GlobalName exports an output parameter to the global scope, making it available as '{{io.argoproj.workflow.v1alpha1.outputs.parameters.XXXX}} and in workflow.status.outputs.parameters",
      "type": "string"
    },
    "name": {
      "description": "Name is the parameter name",
      "type": "string"
    },
    "value": {
      "description": "Value is the literal value to use for the parameter. If specified in the context of an input parameter, any passed values take precedence over the specified value",
      "type": "string"
    },
    "valueFrom": {
      "description": "ValueFrom is the source for the output parameter's value",
      "$ref": "#/definitions/io.argoproj.workflow.v1alpha1.ValueFrom"
    }
  },
  "required": [
    "name"
  ]
}