api icon indicating copy to clipboard operation
api copied to clipboard
verified publisher icon operator-framework

Godoc missing from Subscription API

Open adambkaplan opened this issue 2 years ago • 1 comments

The Subscription API (v1alpha1) is missing godoc descriptions for SubscriptionSpec fields. Godoc descriptions for APIs can help clarify the behavior of OLM subscriptions.

The startingCSV field in particular needs a descriptive comment. For example, can this be used to "pin" the version of a deployed operator if such version exists in the referenced catalog?

See https://github.com/operator-framework/api/blob/master/pkg/operators/v1alpha1/subscription_types.go#L30-L39

adambkaplan avatar Mar 06 '23 17:03 adambkaplan

Issues go stale after 90 days of inactivity. If there is no further activity, the issue will be closed in another 30 days.

github-actions[bot] avatar May 28 '25 01:05 github-actions[bot]