Skip to content
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.

Sign up for GitHub

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

Jump to bottom

Expose v1 examples for v1 API Docs #14992

Closed
whitneygriffith opened this issue Apr 29, 2024 · 3 comments · Fixed by istio/api#3192 or #15515
Closed

Expose v1 examples for v1 API Docs #14992

whitneygriffith opened this issue Apr 29, 2024 · 3 comments · Fixed by istio/api#3192 or #15515
Assignees
@whitneygriffith

Comments

@whitneygriffith
Copy link
Contributor

The below API docs need to be updated to show the v1 examples.
DestinationRule
Gateway
ServiceEntry
Sidecar
VirtualService
WorkloadEntry
WorkloadGroup
Telemetry API*
PeerAuthentication
@ericvn ericvn mentioned this issue May 1, 2024
Open
@professorabhay
Copy link

Hi, Can you provide additional context about that?

@whitneygriffith
Copy link
Contributor Author

whitneygriffith commented May 6, 2024 •
edited
Loading

Hi, Can you provide additional context about that?

On the current website, within the YAML examples you will see an example provided for the v1alpha3 and v1beta1 API versions.

But since these APIs were promoted to v1 the website now shows only v1beta YAML examples.

Ideally we would like for the v1 examples to be shown as defined in the proto

@whitneygriffith whitneygriffith mentioned this issue May 14, 2024
Merged
@whitneygriffith
Copy link
Contributor Author

The handwritten docs like these need to be updated as well.

@whitneygriffith whitneygriffith mentioned this issue Aug 6, 2024
Merged
@craigbox craigbox linked a pull request Aug 6, 2024 that will close this issue
Update to v1 in all API examples #15515
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@whitneygriffith whitneygriffith

Labels
None yet
Projects
None yet
Milestone
No milestone
2 participants
@whitneygriffith @professorabhay