Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Godoc missing from Subscription API #280

Open
adambkaplan opened this issue Mar 6, 2023 · 0 comments
Open

Godoc missing from Subscription API #280

adambkaplan opened this issue Mar 6, 2023 · 0 comments

Comments

@adambkaplan
Copy link

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
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@adambkaplan