-
Notifications
You must be signed in to change notification settings - Fork 510
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
feat(AIP-123): require singular and plural #1091
feat(AIP-123): require singular and plural #1091
Conversation
Requiring singular and plural annotations on resources can enable new use cases in code generation and documentation, and prevents incorrect inferences about these values from the resource type. See googleapis/api-linter#722 for additional discussion around the usage of singular and plural.
9a5b800
to
afb35c9
Compare
Seems reasonable, but does it entirely address 1089? What about validating name/parent? |
Sorry, it doesn't fix #1089 at all. I must have gotten mixed up when I was batching these changes up. Removed that tag. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This is similar to specification of singular and plural in K8s CRDs:
https://kubernetes.io/docs/tasks/extend-kubernetes/custom-resources/custom-resource-definitions/#create-a-customresourcedefinition
There are a bunch of cases where guessing one from the other is not trivial. Plurals were a bad idea, but we are stuck with them.
So LGTM.
On Tue, May 9, 2023 at 9:39 AM Brian Grant ***@***.***> wrote:
***@***.**** approved this pull request.
This is similar to specification of singular and plural in K8s CRDs:
Link was supposed to be:
https://kubernetes.io/docs/tasks/extend-kubernetes/custom-resources/custom-resource-definitions/#create-a-customresourcedefinition
… There are a bunch of cases where guessing one from the other is not
trivial. Plurals were a bad idea, but we are stuck with them.
So LGTM.
—
Reply to this email directly, view it on GitHub
<#1091 (review)>,
or unsubscribe
<https://github.com/notifications/unsubscribe-auth/AB26FUIIFSSFONTFXD7U6JTXFJXMFANCNFSM6AAAAAAXYK7JFQ>
.
You are receiving this because you are subscribed to this thread.Message
ID: ***@***.***>
|
Thanks! one note that conflicts with the KRM CRD guidance is that the singular and plural must be KRM says all lowercase, so you don't know when one word ends and another begins. I actually think KRM should update in kind but I doubt it's a change that's do-able now. |
When your comment doesn't follow the guidance :P |
- moving singular / plural pattern guidance as nested bullets.
Requiring singular and plural annotations on resources can enable new use cases in code generation and documentation, and prevents incorrect inferences about these values from the resource type.
See googleapis/api-linter#722 for additional discussion around the usage of singular and plural.