kubernetes / website

Kubernetes website and documentation repo:
https://kubernetes.io
Creative Commons Attribution 4.0 International
4.5k stars 14.43k forks source link

pods/exec and pods/attach missing from API one pager #39259

Closed RichardoC closed 1 month ago

RichardoC commented 1 year ago

What happened?

Grepping through the api one pager for /exec/ and /attach doesn't show anything

What did you expect to happen?

The exec and attach API to be documented fully on the API one pager

How can we reproduce it (as minimally and precisely as possible)?

Go to the relevant API one pager page and search for "/exec/" and see there are no results

Anything else we need to know?

No response

Kubernetes version

```console $ kubectl version WARNING: This version information is deprecated and will be replaced with the output from kubectl version --short. Use --output=yaml|json to get the full version. Client Version: version.Info{Major:"1", Minor:"26", GitVersion:"v1.26.0", GitCommit:"b46a3f887ca979b1a5d14fd39cb1af43e7e5d12d", GitTreeState:"clean", BuildDate:"2022-12-08T19:58:30Z", GoVersion:"go1.19.4", Compiler:"gc", Platform:"linux/amd64"} Kustomize Version: v4.5.7 Server Version: version.Info{Major:"1", Minor:"26", GitVersion:"v1.26.0+k3s2", GitCommit:"f0ec6a4c127b2c671b271974a2f21783f0e3c525", GitTreeState:"clean", BuildDate:"2023-01-11T21:36:41Z", GoVersion:"go1.19.4", Compiler:"gc", Platform:"linux/amd64"} ```

Cloud provider

Rancher Desktop

OS version

```console # On Linux: $ cat /etc/os-release # paste output here $ uname -a # paste output here # On Windows: C:\> wmic os get Caption, Version, BuildNumber, OSArchitecture # paste output here ```

Install tools

Container runtime (CRI) and version (if applicable)

Related plugins (CNI, CSI, ...) and versions (if applicable)

k8s-ci-robot commented 1 year ago

This issue is currently awaiting triage.

If a SIG or subproject determines this is a relevant issue, they will accept it by applying the triage/accepted label and provide further guidance.

The triage/accepted label can be added by org members by writing /triage accepted in a comment.

Instructions for interacting with me using PR comments are available [here](https://git.k8s.io/community/contributors/guide/pull-requests.md). If you have questions or suggestions related to my behavior, please file an issue against the [kubernetes/test-infra](https://github.com/kubernetes/test-infra/issues/new?title=Prow%20issue:) repository.
RichardoC commented 1 year ago

/sig api-machinery

liggitt commented 1 year ago

/transfer website /sig docs /remove-sig api-machinery

this looks to be an issue with the website generator.. the endpoints are listed in the openapi source used as input to the generator

tengqm commented 1 year ago

/triage accepted /priority backlog

I'm considering revising the one-page API reference into a collection of markdown pages (with nested HTML tables). The non-standard operations like pods/exec and pods/attach are not included in the current reference generator. Fixing them there may take some time.

dshebib commented 1 year ago

I wouldn't mind taking a look at fixing the non-standard operations, unless you're thinking to revise the entire generator.

k8s-triage-robot commented 8 months ago

This issue has not been updated in over 1 year, and should be re-triaged.

You can:

For more details on the triage process, see https://www.kubernetes.dev/docs/guide/issue-triage/

/remove-triage accepted

RichardoC commented 8 months ago

This is still relevant

dshebib commented 8 months ago

/assign

k8s-triage-robot commented 5 months ago

The Kubernetes project currently lacks enough contributors to adequately respond to all issues.

This bot triages un-triaged issues according to the following rules:

You can:

Please send feedback to sig-contributor-experience at kubernetes/community.

/lifecycle stale

RichardoC commented 5 months ago

/remove-lifecycle stale

dshebib commented 5 months ago

Fixed in https://github.com/kubernetes-sigs/reference-docs/pull/354 https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.30/#get-connect-exec-pod-v1-core

/close

k8s-ci-robot commented 5 months ago

@dshebib: You can't close an active issue/PR unless you authored it or you are a collaborator.

In response to [this](https://github.com/kubernetes/website/issues/39259#issuecomment-2148531179): >Fixed in https://github.com/kubernetes-sigs/reference-docs/pull/354 >https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.30/#get-connect-exec-pod-v1-core > >/close Instructions for interacting with me using PR comments are available [here](https://git.k8s.io/community/contributors/guide/pull-requests.md). If you have questions or suggestions related to my behavior, please file an issue against the [kubernetes-sigs/prow](https://github.com/kubernetes-sigs/prow/issues/new?title=Prow%20issue:) repository.
k8s-triage-robot commented 2 months ago

The Kubernetes project currently lacks enough contributors to adequately respond to all issues.

This bot triages un-triaged issues according to the following rules:

You can:

Please send feedback to sig-contributor-experience at kubernetes/community.

/lifecycle stale

k8s-triage-robot commented 1 month ago

The Kubernetes project currently lacks enough active contributors to adequately respond to all issues.

This bot triages un-triaged issues according to the following rules:

You can:

Please send feedback to sig-contributor-experience at kubernetes/community.

/lifecycle rotten