openshift / openshift/openshift-docs

VNC token generation API incorrect

Open Beginner friendly
#119,965 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
HTML
Stars
883
Forks
2k
Avg merge
21h 5m
Merged PRs (30d)
737

Description

The following example is wrong now that the feature has gone GA

https://github.com/openshift/openshift-docs/blob/5057fa295aa23e0366707a93e3c0f93a7c48bbed/modules/virt-generate-temporary-token-VNC.adoc?plain=1#L36

It should be v1 not v1alpha.

"https://api.<cluster_fqdn>/apis/token.kubevirt.io/v1/namespaces/<namespace>/virtualmachines/<vm_name>/vnc?duration=<duration>"

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Update modules/virt-generate-temporary-token-VNC.adoc at the linked example around line 36. Change the token API path version from v1alpha to v1, then verify the displayed URL matches the issue and the GA API format.

Written by the indexing model from the issue text.

Assessment

Domain
api, documentation
Issue type
Documentation
Difficulty
1/5
Estimated time
Under an hour
Activity status
Active
Clarity
Clearly specified
Newbie friendliness
95/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.