Owner: Architect:

Story (Required)

As a Service Provider I will like to be able to set an optional flag in my sbo annotation to indicate whether the mapping is required or optional

Background (Required)

Some annotations could be optional. For example link to credentials might not be there is the service endpoint does not require authentication.

Glossary

NA

Out of scope

NA

In Scope

NA

Approach(Required)

The idea is to do the following:

Add logic in SBO to take into account a new field in the annotation providing the mapping, optional=true/false. If optional true then we will do the mapping only if the target path is available. When target path is not available we would skip it without failures. However, when optional is false we will fail when path is not found.

Since this was brought up in an issue in our github repo any discussion should take place there: https://github.com/redhat-developer/service-binding-operator/issues/1088

Dependencies

NA

Edge Case

If optional is not defined it is assumed to be false, and we should fail if the mapping is not realized.

Acceptance Criteria

We support the optional field in our CRD annotations.
We have test cases covering this scenario
We have documentation we can point service providers to when they enable their services.

INVEST Checklist

Dependencies identified
Blockers noted and expected delivery timelines set
Design is implementable
Acceptance criteria agreed upon
Story estimated

Legend

Unknown
Verified
Unsatisfied