Re: [kubernetes/kubernetes] Documentation fix: Explain resourceVersion=0 for watch calls (#64798)

0 views
Skip to first unread message

Daniel Smith

unread,
Jun 6, 2018, 12:24:20 PM6/6/18
to kubernetes/kubernetes, k8s-mirror-api-machinery-api-reviews, Team mention

@lavalamp commented on this pull request.


In staging/src/k8s.io/apimachinery/pkg/apis/meta/v1/types.go:

> @@ -333,9 +333,12 @@ type ListOptions struct {
 	// add, update, and remove notifications. Specify resourceVersion.
 	// +optional
 	Watch bool `json:"watch,omitempty" protobuf:"varint,3,opt,name=watch"`
-	// When specified with a watch call, shows changes that occur after that particular version of a resource.
+	// When specified with a watch call:
+	// shows changes that occur after that particular version of a resource.
+	// If it's 0, then the result will be current objects directory defined by key in "ADDED" events

+1 to this, plus also include the leading - on these bullet points for clarity, or convert to prose (but - bullet points are consistent with the list section).


You are receiving this because you are on a team that was mentioned.
Reply to this email directly, view it on GitHub, or mute the thread.

Jordan Liggitt

unread,
Jun 6, 2018, 12:38:16 PM6/6/18
to kubernetes/kubernetes, k8s-mirror-api-machinery-api-reviews, Team mention

@liggitt commented on this pull request.


In staging/src/k8s.io/apimachinery/pkg/apis/meta/v1/types.go:

> @@ -333,9 +333,12 @@ type ListOptions struct {
 	// add, update, and remove notifications. Specify resourceVersion.
 	// +optional
 	Watch bool `json:"watch,omitempty" protobuf:"varint,3,opt,name=watch"`
-	// When specified with a watch call, shows changes that occur after that particular version of a resource.
+	// When specified with a watch call:
+	// shows changes that occur after that particular version of a resource.
+	// If it's 0, then the result will be current objects directory defined by key in "ADDED" events

fwiw, the bullets don't render great in contexts like https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.10/#list-62

Daniel Smith

unread,
Jun 6, 2018, 1:19:16 PM6/6/18
to kubernetes/kubernetes, k8s-mirror-api-machinery-api-reviews, Team mention
Good point. Is there a way to at least get paragraph breaks? That is an
incomprehensible wall of text.

On Wed, Jun 6, 2018 at 9:38 AM Jordan Liggitt <notifi...@github.com>
wrote:

> *@liggitt* commented on this pull request.
> ------------------------------
>
> In staging/src/k8s.io/apimachinery/pkg/apis/meta/v1/types.go
> <https://github.com/kubernetes/kubernetes/pull/64798#discussion_r193477748>

> :
>
> > @@ -333,9 +333,12 @@ type ListOptions struct {
> // add, update, and remove notifications. Specify resourceVersion.
> // +optional
> Watch bool `json:"watch,omitempty" protobuf:"varint,3,opt,name=watch"`
> - // When specified with a watch call, shows changes that occur after that particular version of a resource.
> + // When specified with a watch call:
> + // shows changes that occur after that particular version of a resource.
> + // If it's 0, then the result will be current objects directory defined by key in "ADDED" events
>
> fwiw, the bullets don't render great in contexts like
> https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.10/#list-62
>
> —
> You are receiving this because you are on a team that was mentioned.
> Reply to this email directly, view it on GitHub
> <https://github.com/kubernetes/kubernetes/pull/64798#discussion_r193477748>,
> or mute the thread
> <https://github.com/notifications/unsubscribe-auth/AAngll9Zxehjf5bxH_M84qblM4ZVgOjWks5t6AV2gaJpZM4UbwFx>
> .

Kubernetes Submit Queue

unread,
Jun 7, 2018, 4:30:12 AM6/7/18
to kubernetes/kubernetes, k8s-mirror-api-machinery-api-reviews, Team mention

[MILESTONENOTIFIER] Milestone Pull Request Labels Incomplete

@liggitt @mbohlool

Action required: This pull request requires label changes. If the required changes are not made within 2 days, the pull request will be moved out of the v1.11 milestone.

kind: Must specify exactly one of kind/bug, kind/cleanup or kind/feature.
priority: Must specify exactly one of priority/critical-urgent, priority/important-longterm or priority/important-soon.

Help

Jenny Buckley

unread,
Jun 7, 2018, 4:14:09 PM6/7/18
to kubernetes/kubernetes, k8s-mirror-api-machinery-api-reviews, Team mention

/cc @jpbetz

Josh Berkus

unread,
Jun 7, 2018, 7:18:54 PM6/7/18
to kubernetes/kubernetes, k8s-mirror-api-machinery-api-reviews, Team mention

Removing this from milestone; it's not ready, it's not approved, and it's not clear that we need it for 1.11.

k8s-ci-robot

unread,
Jun 15, 2018, 2:54:13 PM6/15/18
to kubernetes/kubernetes, k8s-mirror-api-machinery-api-reviews, Team mention

@mbohlool: The following test failed, say /retest to rerun them all:

Test name Commit Details Rerun command
pull-kubernetes-verify 36eb4fb link /test pull-kubernetes-verify

Full PR test history. Your PR dashboard. Please help us cut down on flakes by linking to an open issue when you hit one in your PR.

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository. I understand the commands that are listed here.

k8s-ci-robot

unread,
Aug 30, 2018, 2:13:04 AM8/30/18
to kubernetes/kubernetes, k8s-mirror-api-machinery-api-reviews, Team mention

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by: mbohlool
To fully approve this pull request, please assign additional approvers.
We suggest the following additional approver: liggitt

If they are not already assigned, you can assign the PR to them by writing /assign @liggitt in a comment when ready.

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Needs approval from an approver in each of these files:

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

k8s-ci-robot

unread,
Aug 30, 2018, 2:52:01 AM8/30/18
to kubernetes/kubernetes, k8s-mirror-api-machinery-api-reviews, Team mention

@mbohlool: The following test failed, say /retest to rerun them all:

Test name Commit Details Rerun command
pull-kubernetes-verify 2b03f37 link /test pull-kubernetes-verify

Full PR test history. Your PR dashboard. Please help us cut down on flakes by linking to an open issue when you hit one in your PR.

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository. I understand the commands that are listed here.

fejta-bot

unread,
Nov 28, 2018, 2:50:47 AM11/28/18
to kubernetes/kubernetes, k8s-mirror-api-machinery-api-reviews, Team mention

Issues go stale after 90d of inactivity.
Mark the issue as fresh with /remove-lifecycle stale.
Stale issues rot after an additional 30d of inactivity and eventually close.

If this issue is safe to close now please do so with /close.

Send feedback to sig-testing, kubernetes/test-infra and/or fejta.
/lifecycle stale

Wenjia

unread,
Nov 28, 2018, 4:03:50 PM11/28/18
to kubernetes/kubernetes, k8s-mirror-api-machinery-api-reviews, Team mention

/remove-lifecycle stale

Wenjia

unread,
Nov 28, 2018, 4:04:12 PM11/28/18
to kubernetes/kubernetes, k8s-mirror-api-machinery-api-reviews, Team mention

/test pull-kubernetes-verify

k8s-ci-robot

unread,
Nov 28, 2018, 4:43:34 PM11/28/18
to kubernetes/kubernetes, k8s-mirror-api-machinery-api-reviews, Team mention

@mbohlool: The following test failed, say /retest to rerun them all:

Test name Commit Details Rerun command
pull-kubernetes-verify 2b03f37 link /test pull-kubernetes-verify

Full PR test history. Your PR dashboard. Please help us cut down on flakes by linking to an open issue when you hit one in your PR.

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository. I understand the commands that are listed here.

Wenjia

unread,
Nov 28, 2018, 5:43:08 PM11/28/18
to kubernetes/kubernetes, k8s-mirror-api-machinery-api-reviews, Team mention

/test pull-kubernetes-verify

k8s-ci-robot

unread,
Nov 28, 2018, 6:22:25 PM11/28/18
to kubernetes/kubernetes, k8s-mirror-api-machinery-api-reviews, Team mention

@mbohlool: The following test failed, say /retest to rerun them all:

Test name Commit Details Rerun command
pull-kubernetes-verify 2b03f37 link /test pull-kubernetes-verify

Full PR test history. Your PR dashboard. Please help us cut down on flakes by linking to an open issue when you hit one in your PR.

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository. I understand the commands that are listed here.

Jordan Liggitt

unread,
Dec 3, 2018, 1:56:00 PM12/3/18
to kubernetes/kubernetes, k8s-mirror-api-machinery-api-reviews, Team mention

@liggitt commented on this pull request.


In staging/src/k8s.io/apimachinery/pkg/apis/meta/v1/types.go:

> @@ -333,9 +333,12 @@ type ListOptions struct {
 	// add, update, and remove notifications. Specify resourceVersion.
 	// +optional
 	Watch bool `json:"watch,omitempty" protobuf:"varint,3,opt,name=watch"`
-	// When specified with a watch call, shows changes that occur after that particular version of a resource.
+	// When specified with a watch call:
+	// shows changes that occur after that particular version of a resource.
+	// If it's 0, then the result will be current objects directory defined by key in "ADDED" events

"current objects directory defined by key" doesn't have a lot of meaning for a REST API call

Jordan Liggitt

unread,
Feb 15, 2019, 12:55:15 AM2/15/19
to kubernetes/kubernetes, k8s-mirror-api-machinery-api-reviews, Team mention

closing for lack of activity
/close

Kubernetes Prow Robot

unread,
Feb 15, 2019, 12:55:28 AM2/15/19
to kubernetes/kubernetes, k8s-mirror-api-machinery-api-reviews, Team mention

@liggitt: Closed this PR.

In response to this:

closing for lack of activity
/close

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository.

Kubernetes Prow Robot

unread,
Feb 15, 2019, 12:55:31 AM2/15/19
to kubernetes/kubernetes, k8s-mirror-api-machinery-api-reviews, Team mention

Closed #64798.

Reply all
Reply to author
Forward
0 new messages