-
Notifications
You must be signed in to change notification settings - Fork 14.4k
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
v1 is specified in apiVersion field #4127
Conversation
I am not equipped to answer this question myself (I am confused too) so I will defer the tech review to someone else. cc: @kubernetes/sig-api-machinery-pr-reviews |
@@ -77,7 +77,7 @@ The API group is specified in a REST path and in the `apiVersion` field of a ser | |||
Currently there are several API groups in use: | |||
|
|||
1. the "core" (oftentimes called "legacy", due to not having explicit group name) group, which is at | |||
REST path `/api/v1` and is not specified as part of the `apiVersion` field, e.g. `apiVersion: v1`. | |||
REST path `/api/v1` and is specified as part of the `apiVersion` field, e.g. `apiVersion: v1`. |
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.
it is meant that the apiVersion
value is not /v1
(i.e. empty group name), but v1
.
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.
@madorn 👋 hello there, do you have time to address the PR feedback?
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.
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.
maybe we should reformulate the sentence and avoid "be or not be specified". Seems to be hard to understand.
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.
So, should the sentence be:
The core group, often referred to as legacy, is at REST path /api/v1
and can be accessed using apiVersion: v1
.
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.
"can be accessed using ..." still sounds odd.
How about
The core group, often referred to as the "legacy group", is at the REST path /api/v1 and uses `apiVersion: v1`.
E.g. the same wording as in the next paragraph.
Sorry, I don't agree with this change. The group name "core" is not specified as part of the apiVersion field. So this sentence seems incorrect to me: the “core” ... group, which is at REST path /api/v1 and is specified as part of the apiVersion field, e.g. apiVersion: v1. |
@steveperry-53 compare my comment #4127 (comment). The point of the PR is to clarify exactly this. So the issue is still open and correct variants are proposed in the review comments. We are just waiting for the PR being updated. |
I think the best course of action is to close this PR and open another. |
In the interest of moving this forward, I'm going to create a duplicate. |
The use of
not
here may be confusing to newcomers.Is the intention to suggest the
apiVersion
field defaults to v1 unless otherwise specified?This change is