-
Notifications
You must be signed in to change notification settings - Fork 77
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.
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
Improve API documentation for CSV and PackageManifest #167
Comments
I am working on a PR for this. |
Fixes operator-framework#167 Add descriptions for kind, name, and version properties of APIResourceReference schema.
Fixes operator-framework#167 Add descriptions for kind, name, and version properties of APIResourceReference schema.
Hey, just wanted to add some color - found myself here after running Some are a little obvious (maintainer), others, not so much (provider? urls?) having at least some |
Fixes operator-framework#167 Add descriptions for kind, name, and version properties of APIResourceReference schema.
Fixes operator-framework#167 Add descriptions for kind, name, and version properties of APIResourceReference schema.
Fixes operator-framework#167 Add descriptions for kind, name, and version properties of APIResourceReference schema.
The API documentaion for ClusterServiceVerion is incomplete for the following properties:
CSV properties:
These all share the same description:
I've searched through OpenShift, Kubernetes, and Operator Framework repos and documentation and cannot find any further reference to an
APIResourceReference
schema. The schema consists of three string-type properties:kind
,name
, andversion
. These properties have no description defined in the schema.The
resource[]
properties above are currently only consumed by the web console in order to list related resources on operand details pages, but we recently had a bug opened where this API was being misused. Adding some descriptions might be helpful in preventing future bugs or confusion.The text was updated successfully, but these errors were encountered: