Skip to content

Provide example of entirely optional inputs

Fabio Pitino requested to merge docs/ci-components-default-null-inputs into master

What does this MR do and why?

From a customer feedback on spec:inputs syntax:

I feel that mixing default value with the optionality of the value is a little confusing. Why not be explicit?

We already support entirely optional input parameters, meaning them being optional and having no default value:

---
spec:
  inputs:
    foo:
      default: null # this param is optional and by default it gets no value assigned
    bar:
      default:      # equivalent syntax to the above

In this MR we are updating the blueprint with an example to ensure it's clear how the generic syntax default: can provide such functionality.

Screenshots or screen recordings

Screenshots are required for UI changes, and strongly recommended for all other merge requests.

How to set up and validate locally

Numbered steps to set up and validate the change are strongly suggested.

MR acceptance checklist

This checklist encourages us to confirm any changes have been analyzed to reduce risks in quality, performance, reliability, security, and maintainability.

Merge request reports