Template [template.openshift.io/v1]

    Template contains the inputs needed to produce a Config.

    Type

    Required

    Description

    parameters is an optional array of Parameters used during the Template to Config transformation.

    Type

    array

    .parameters[]

    Description

    Parameter defines a name/value variable that is to be processed during the Template to Config transformation.

    Type

    object

    Required

    • name
    PropertyTypeDescription

    description

    string

    Description of a parameter. Optional.

    displayName

    string

    Optional: The name that will show in UI instead of parameter ‘Name’

    from

    string

    From is an input value for the generator. Optional.

    generate

    string

    generate specifies the generator to be used to generate random string from an input value specified by From field. The result string is stored into Value field. If empty, no generator is being used, leaving the result Value untouched. Optional.

    The only supported generator is “expression”, which accepts a “from” value in the form of a simple regular expression containing the range expression “[a-zA-Z0-9]”, and the length expression “a{length}”.

    Examples:

    from | value ——————————————- “test[0-9]{1}x” | “test7x” “[0-1]{8}” | “01001100” “0x[A-F0-9]{4}” | “0xB3AF” “[a-zA-Z0-9]{8}” | “hW4yQU5i”

    name

    string

    required

    Optional: Indicates the parameter must have a value. Defaults to false.

    value

    string

    Value holds the Parameter data. If specified, the generator will be ignored. The value replaces all occurrences of the Parameter ${Name} expression during the Template to Config transformation. Optional.

    API endpoints

    The following API endpoints are available:

    Table 2. Global query parameters
    ParameterTypeDescription

    dryRun

    string

    When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed

    fieldManager

    string

    fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by .

    pretty

    string

    If ‘true’, then the output is pretty printed.

    HTTP method

    POST

    Description

    create a Template

    Table 4. HTTP responses
    HTTP codeReponse body

    200 - OK